The properties required to query Amazon S3.
" } }, + "S3InputFileType": { + "base": null, + "refs": { + "S3InputFormatConfig$s3InputFileType": "The file type that Amazon AppFlow gets from your Amazon S3 bucket.
" + } + }, + "S3InputFormatConfig": { + "base": "When you use Amazon S3 as the source, the configuration format that you provide the flow input data.
", + "refs": { + "S3SourceProperties$s3InputFormatConfig": null + } + }, "S3Metadata": { "base": "The connector metadata specific to Amazon S3.
", "refs": { diff --git a/models/apis/directconnect/2012-10-25/api-2.json b/models/apis/directconnect/2012-10-25/api-2.json index 34268aa77c..943d1ca96b 100644 --- a/models/apis/directconnect/2012-10-25/api-2.json +++ b/models/apis/directconnect/2012-10-25/api-2.json @@ -164,6 +164,19 @@ {"shape":"DirectConnectClientException"} ] }, + "ConfirmCustomerAgreement":{ + "name":"ConfirmCustomerAgreement", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ConfirmCustomerAgreementRequest"}, + "output":{"shape":"ConfirmCustomerAgreementResponse"}, + "errors":[ + {"shape":"DirectConnectServerException"}, + {"shape":"DirectConnectClientException"} + ] + }, "ConfirmPrivateVirtualInterface":{ "name":"ConfirmPrivateVirtualInterface", "http":{ @@ -490,6 +503,18 @@ ], "deprecated":true }, + "DescribeCustomerMetadata":{ + "name":"DescribeCustomerMetadata", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "output":{"shape":"DescribeCustomerMetadataResponse"}, + "errors":[ + {"shape":"DirectConnectServerException"}, + {"shape":"DirectConnectClientException"} + ] + }, "DescribeDirectConnectGatewayAssociationProposals":{ "name":"DescribeDirectConnectGatewayAssociationProposals", "http":{ @@ -620,6 +645,19 @@ {"shape":"DirectConnectClientException"} ] }, + "DescribeRouterConfiguration":{ + "name":"DescribeRouterConfiguration", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeRouterConfigurationRequest"}, + "output":{"shape":"DescribeRouterConfigurationResponse"}, + "errors":[ + {"shape":"DirectConnectServerException"}, + {"shape":"DirectConnectClientException"} + ] + }, "DescribeTags":{ "name":"DescribeTags", "http":{ @@ -764,6 +802,19 @@ {"shape":"DirectConnectClientException"} ] }, + "UpdateDirectConnectGateway":{ + "name":"UpdateDirectConnectGateway", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UpdateDirectConnectGatewayRequest"}, + "output":{"shape":"UpdateDirectConnectGatewayResponse"}, + "errors":[ + {"shape":"DirectConnectServerException"}, + {"shape":"DirectConnectClientException"} + ] + }, "UpdateDirectConnectGatewayAssociation":{ "name":"UpdateDirectConnectGatewayAssociation", "http":{ @@ -833,6 +884,14 @@ "ipv6" ] }, + "AgreementList":{ + "type":"list", + "member":{"shape":"CustomerAgreement"} + }, + "AgreementName":{ + "type":"string", + "max":100 + }, "AllocateConnectionOnInterconnectRequest":{ "type":"structure", "required":[ @@ -1049,6 +1108,18 @@ "connectionState":{"shape":"ConnectionState"} } }, + "ConfirmCustomerAgreementRequest":{ + "type":"structure", + "members":{ + "agreementName":{"shape":"AgreementName"} + } + }, + "ConfirmCustomerAgreementResponse":{ + "type":"structure", + "members":{ + "status":{"shape":"Status"} + } + }, "ConfirmPrivateVirtualInterfaceRequest":{ "type":"structure", "required":["virtualInterfaceId"], @@ -1305,6 +1376,13 @@ } }, "CustomerAddress":{"type":"string"}, + "CustomerAgreement":{ + "type":"structure", + "members":{ + "agreementName":{"shape":"AgreementName"}, + "status":{"shape":"Status"} + } + }, "DeleteBGPPeerRequest":{ "type":"structure", "members":{ @@ -1428,6 +1506,13 @@ "connectionId":{"shape":"ConnectionId"} } }, + "DescribeCustomerMetadataResponse":{ + "type":"structure", + "members":{ + "agreements":{"shape":"AgreementList"}, + "nniPartnerType":{"shape":"NniPartnerType"} + } + }, "DescribeDirectConnectGatewayAssociationProposalsRequest":{ "type":"structure", "members":{ @@ -1537,6 +1622,23 @@ "loaContentType":{"shape":"LoaContentType"} } }, + "DescribeRouterConfigurationRequest":{ + "type":"structure", + "required":["virtualInterfaceId"], + "members":{ + "virtualInterfaceId":{"shape":"VirtualInterfaceId"}, + "routerTypeIdentifier":{"shape":"RouterTypeIdentifier"} + } + }, + "DescribeRouterConfigurationResponse":{ + "type":"structure", + "members":{ + "customerRouterConfig":{"shape":"RouterConfig"}, + "router":{"shape":"RouterType"}, + "virtualInterfaceId":{"shape":"VirtualInterfaceId"}, + "virtualInterfaceName":{"shape":"VirtualInterfaceName"} + } + }, "DescribeTagsRequest":{ "type":"structure", "required":["resourceArns"], @@ -2026,9 +2128,18 @@ "tags":{"shape":"TagList"} } }, + "NniPartnerType":{ + "type":"string", + "enum":[ + "v1", + "v2", + "nonPartner" + ] + }, "OwnerAccount":{"type":"string"}, "PaginationToken":{"type":"string"}, "PartnerName":{"type":"string"}, + "Platform":{"type":"string"}, "PortEncryptionStatus":{"type":"string"}, "PortSpeed":{"type":"string"}, "ProviderList":{ @@ -2065,7 +2176,20 @@ "member":{"shape":"RouteFilterPrefix"} }, "RouterConfig":{"type":"string"}, + "RouterType":{ + "type":"structure", + "members":{ + "vendor":{"shape":"Vendor"}, + "platform":{"shape":"Platform"}, + "software":{"shape":"Software"}, + "xsltTemplateName":{"shape":"XsltTemplateName"}, + "xsltTemplateNameForMacSec":{"shape":"XsltTemplateNameForMacSec"}, + "routerTypeIdentifier":{"shape":"RouterTypeIdentifier"} + } + }, + "RouterTypeIdentifier":{"type":"string"}, "SecretARN":{"type":"string"}, + "Software":{"type":"string"}, "StartBgpFailoverTestRequest":{ "type":"structure", "required":["virtualInterfaceId"], @@ -2085,6 +2209,10 @@ "StartTime":{"type":"timestamp"}, "State":{"type":"string"}, "StateChangeError":{"type":"string"}, + "Status":{ + "type":"string", + "max":30 + }, "StopBgpFailoverTestRequest":{ "type":"structure", "required":["virtualInterfaceId"], @@ -2193,6 +2321,23 @@ "directConnectGatewayAssociation":{"shape":"DirectConnectGatewayAssociation"} } }, + "UpdateDirectConnectGatewayRequest":{ + "type":"structure", + "required":[ + "directConnectGatewayId", + "newDirectConnectGatewayName" + ], + "members":{ + "directConnectGatewayId":{"shape":"DirectConnectGatewayId"}, + "newDirectConnectGatewayName":{"shape":"DirectConnectGatewayName"} + } + }, + "UpdateDirectConnectGatewayResponse":{ + "type":"structure", + "members":{ + "directConnectGateway":{"shape":"DirectConnectGateway"} + } + }, "UpdateLagRequest":{ "type":"structure", "required":["lagId"], @@ -2212,6 +2357,7 @@ } }, "VLAN":{"type":"integer"}, + "Vendor":{"type":"string"}, "VirtualGateway":{ "type":"structure", "members":{ @@ -2309,6 +2455,8 @@ "members":{ "virtualInterfaces":{"shape":"VirtualInterfaceList"} } - } + }, + "XsltTemplateName":{"type":"string"}, + "XsltTemplateNameForMacSec":{"type":"string"} } } diff --git a/models/apis/directconnect/2012-10-25/docs-2.json b/models/apis/directconnect/2012-10-25/docs-2.json index f7acebd15e..767ad1d518 100644 --- a/models/apis/directconnect/2012-10-25/docs-2.json +++ b/models/apis/directconnect/2012-10-25/docs-2.json @@ -1,29 +1,30 @@ { "version": "2.0", - "service": "Direct Connect links your internal network to an Direct Connect location over a standard Ethernet fiber-optic cable. One end of the cable is connected to your router, the other to an Direct Connect router. With this connection in place, you can create virtual interfaces directly to the Cloud (for example, to Amazon EC2 and Amazon S3) and to Amazon VPC, bypassing Internet service providers in your network path. A connection provides access to all Regions except the China (Beijing) and (China) Ningxia Regions. Amazon Web Services resources in the China Regions can only be accessed through locations associated with those Regions.
", + "service": "Direct Connect links your internal network to an Direct Connect location over a standard Ethernet fiber-optic cable. One end of the cable is connected to your router, the other to an Direct Connect router. With this connection in place, you can create virtual interfaces directly to the Amazon Web Services Cloud (for example, to Amazon EC2 and Amazon S3) and to Amazon VPC, bypassing Internet service providers in your network path. A connection provides access to all Amazon Web Services Regions except the China (Beijing) and (China) Ningxia Regions. Amazon Web Services resources in the China Regions can only be accessed through locations associated with those Regions.
", "operations": { "AcceptDirectConnectGatewayAssociationProposal": "Accepts a proposal request to attach a virtual private gateway or transit gateway to a Direct Connect gateway.
", "AllocateConnectionOnInterconnect": "Deprecated. Use AllocateHostedConnection instead.
Creates a hosted connection on an interconnect.
Allocates a VLAN number and a specified amount of bandwidth for use by a hosted connection on the specified interconnect.
Intended for use by Direct Connect Partners only.
Creates a hosted connection on the specified interconnect or a link aggregation group (LAG) of interconnects.
Allocates a VLAN number and a specified amount of capacity (bandwidth) for use by a hosted connection on the specified interconnect or LAG of interconnects. Amazon Web Services polices the hosted connection for the specified capacity and the Direct Connect Partner must also police the hosted connection for the specified capacity.
Intended for use by Direct Connect Partners only.
Provisions a private virtual interface to be owned by the specified account.
Virtual interfaces created using this action must be confirmed by the owner using ConfirmPrivateVirtualInterface. Until then, the virtual interface is in the Confirming state and is not available to handle traffic.
Provisions a public virtual interface to be owned by the specified account.
The owner of a connection calls this function to provision a public virtual interface to be owned by the specified account.
Virtual interfaces created using this function must be confirmed by the owner using ConfirmPublicVirtualInterface. Until this step has been completed, the virtual interface is in the confirming state and is not available to handle traffic.
When creating an IPv6 public virtual interface, omit the Amazon address and customer address. IPv6 addresses are automatically assigned from the Amazon pool of IPv6 addresses; you cannot specify custom IPv6 addresses.
", - "AllocateTransitVirtualInterface": "Provisions a transit virtual interface to be owned by the specified account. Use this type of interface to connect a transit gateway to your Direct Connect gateway.
The owner of a connection provisions a transit virtual interface to be owned by the specified account.
After you create a transit virtual interface, it must be confirmed by the owner using ConfirmTransitVirtualInterface. Until this step has been completed, the transit virtual interface is in the requested state and is not available to handle traffic.
Provisions a private virtual interface to be owned by the specified Amazon Web Services account.
Virtual interfaces created using this action must be confirmed by the owner using ConfirmPrivateVirtualInterface. Until then, the virtual interface is in the Confirming state and is not available to handle traffic.
Provisions a public virtual interface to be owned by the specified Amazon Web Services account.
The owner of a connection calls this function to provision a public virtual interface to be owned by the specified Amazon Web Services account.
Virtual interfaces created using this function must be confirmed by the owner using ConfirmPublicVirtualInterface. Until this step has been completed, the virtual interface is in the confirming state and is not available to handle traffic.
When creating an IPv6 public virtual interface, omit the Amazon address and customer address. IPv6 addresses are automatically assigned from the Amazon pool of IPv6 addresses; you cannot specify custom IPv6 addresses.
", + "AllocateTransitVirtualInterface": "Provisions a transit virtual interface to be owned by the specified Amazon Web Services account. Use this type of interface to connect a transit gateway to your Direct Connect gateway.
The owner of a connection provisions a transit virtual interface to be owned by the specified Amazon Web Services account.
After you create a transit virtual interface, it must be confirmed by the owner using ConfirmTransitVirtualInterface. Until this step has been completed, the transit virtual interface is in the requested state and is not available to handle traffic.
Associates an existing connection with a link aggregation group (LAG). The connection is interrupted and re-established as a member of the LAG (connectivity to Amazon Web Services is interrupted). The connection must be hosted on the same Direct Connect endpoint as the LAG, and its bandwidth must match the bandwidth for the LAG. You can re-associate a connection that's currently associated with a different LAG; however, if removing the connection would cause the original LAG to fall below its setting for minimum number of operational connections, the request fails.
Any virtual interfaces that are directly associated with the connection are automatically re-associated with the LAG. If the connection was originally associated with a different LAG, the virtual interfaces remain associated with the original LAG.
For interconnects, any hosted connections are automatically re-associated with the LAG. If the interconnect was originally associated with a different LAG, the hosted connections remain associated with the original LAG.
", "AssociateHostedConnection": "Associates a hosted connection and its virtual interfaces with a link aggregation group (LAG) or interconnect. If the target interconnect or LAG has an existing hosted connection with a conflicting VLAN number or IP address, the operation fails. This action temporarily interrupts the hosted connection's connectivity to Amazon Web Services as it is being migrated.
Intended for use by Direct Connect Partners only.
Associates a MAC Security (MACsec) Connection Key Name (CKN)/ Connectivity Association Key (CAK) pair with an Direct Connect dedicated connection.
You must supply either the secretARN, or the CKN/CAK (ckn and cak) pair in the request.
For information about MAC Security (MACsec) key considerations, see MACsec pre-shared CKN/CAK key considerations in the Direct Connect User Guide.
", "AssociateVirtualInterface": "Associates a virtual interface with a specified link aggregation group (LAG) or connection. Connectivity to Amazon Web Services is temporarily interrupted as the virtual interface is being migrated. If the target connection or LAG has an associated virtual interface with a conflicting VLAN number or a conflicting IP address, the operation fails.
Virtual interfaces associated with a hosted connection cannot be associated with a LAG; hosted connections must be migrated along with their virtual interfaces using AssociateHostedConnection.
To reassociate a virtual interface to a new connection or LAG, the requester must own either the virtual interface itself or the connection to which the virtual interface is currently associated. Additionally, the requester must own the connection or LAG for the association.
", "ConfirmConnection": "Confirms the creation of the specified hosted connection on an interconnect.
Upon creation, the hosted connection is initially in the Ordering state, and remains in this state until the owner confirms creation of the hosted connection.
Accepts ownership of a private virtual interface created by another account.
After the virtual interface owner makes this call, the virtual interface is created and attached to the specified virtual private gateway or Direct Connect gateway, and is made available to handle traffic.
", - "ConfirmPublicVirtualInterface": "Accepts ownership of a public virtual interface created by another account.
After the virtual interface owner makes this call, the specified virtual interface is created and made available to handle traffic.
", - "ConfirmTransitVirtualInterface": "Accepts ownership of a transit virtual interface created by another account.
After the owner of the transit virtual interface makes this call, the specified transit virtual interface is created and made available to handle traffic.
", + "ConfirmCustomerAgreement": "The confirmation of the terms of agreement when creating the connection/link aggregation group (LAG).
", + "ConfirmPrivateVirtualInterface": "Accepts ownership of a private virtual interface created by another Amazon Web Services account.
After the virtual interface owner makes this call, the virtual interface is created and attached to the specified virtual private gateway or Direct Connect gateway, and is made available to handle traffic.
", + "ConfirmPublicVirtualInterface": "Accepts ownership of a public virtual interface created by another Amazon Web Services account.
After the virtual interface owner makes this call, the specified virtual interface is created and made available to handle traffic.
", + "ConfirmTransitVirtualInterface": "Accepts ownership of a transit virtual interface created by another Amazon Web Services account.
After the owner of the transit virtual interface makes this call, the specified transit virtual interface is created and made available to handle traffic.
", "CreateBGPPeer": "Creates a BGP peer on the specified virtual interface.
You must create a BGP peer for the corresponding address family (IPv4/IPv6) in order to access Amazon Web Services resources that also use that address family.
If logical redundancy is not supported by the connection, interconnect, or LAG, the BGP peer cannot be in the same address family as an existing BGP peer on the virtual interface.
When creating a IPv6 BGP peer, omit the Amazon address and customer address. IPv6 addresses are automatically assigned from the Amazon pool of IPv6 addresses; you cannot specify custom IPv6 addresses.
For a public virtual interface, the Autonomous System Number (ASN) must be private or already on the allow list for the virtual interface.
", "CreateConnection": "Creates a connection between a customer network and a specific Direct Connect location.
A connection links your internal network to an Direct Connect location over a standard Ethernet fiber-optic cable. One end of the cable is connected to your router, the other to an Direct Connect router.
To find the locations for your Region, use DescribeLocations.
You can automatically add the new connection to a link aggregation group (LAG) by specifying a LAG ID in the request. This ensures that the new connection is allocated on the same Direct Connect endpoint that hosts the specified LAG. If there are no available ports on the endpoint, the request fails and no connection is created.
", - "CreateDirectConnectGateway": "Creates a Direct Connect gateway, which is an intermediate object that enables you to connect a set of virtual interfaces and virtual private gateways. A Direct Connect gateway is global and visible in any Region after it is created. The virtual interfaces and virtual private gateways that are connected through a Direct Connect gateway can be in different Regions. This enables you to connect to a VPC in any Region, regardless of the Region in which the virtual interfaces are located, and pass traffic between them.
", + "CreateDirectConnectGateway": "Creates a Direct Connect gateway, which is an intermediate object that enables you to connect a set of virtual interfaces and virtual private gateways. A Direct Connect gateway is global and visible in any Amazon Web Services Region after it is created. The virtual interfaces and virtual private gateways that are connected through a Direct Connect gateway can be in different Amazon Web Services Regions. This enables you to connect to a VPC in any Region, regardless of the Region in which the virtual interfaces are located, and pass traffic between them.
", "CreateDirectConnectGatewayAssociation": "Creates an association between a Direct Connect gateway and a virtual private gateway. The virtual private gateway must be attached to a VPC and must not be associated with another Direct Connect gateway.
", - "CreateDirectConnectGatewayAssociationProposal": "Creates a proposal to associate the specified virtual private gateway or transit gateway with the specified Direct Connect gateway.
You can associate a Direct Connect gateway and virtual private gateway or transit gateway that is owned by any account.
", + "CreateDirectConnectGatewayAssociationProposal": "Creates a proposal to associate the specified virtual private gateway or transit gateway with the specified Direct Connect gateway.
You can associate a Direct Connect gateway and virtual private gateway or transit gateway that is owned by any Amazon Web Services account.
", "CreateInterconnect": "Creates an interconnect between an Direct Connect Partner's network and a specific Direct Connect location.
An interconnect is a connection that is capable of hosting other connections. The Direct Connect Partner can use an interconnect to provide Direct Connect hosted connections to customers through their own network services. Like a standard connection, an interconnect links the partner's network to an Direct Connect location over a standard Ethernet fiber-optic cable. One end is connected to the partner's router, the other to an Direct Connect router.
You can automatically add the new interconnect to a link aggregation group (LAG) by specifying a LAG ID in the request. This ensures that the new interconnect is allocated on the same Direct Connect endpoint that hosts the specified LAG. If there are no available ports on the endpoint, the request fails and no interconnect is created.
For each end customer, the Direct Connect Partner provisions a connection on their interconnect by calling AllocateHostedConnection. The end customer can then connect to Amazon Web Services resources by creating a virtual interface on their connection, using the VLAN assigned to them by the Direct Connect Partner.
Intended for use by Direct Connect Partners only.
Creates a link aggregation group (LAG) with the specified number of bundled physical dedicated connections between the customer network and a specific Direct Connect location. A LAG is a logical interface that uses the Link Aggregation Control Protocol (LACP) to aggregate multiple interfaces, enabling you to treat them as a single interface.
All connections in a LAG must use the same bandwidth (either 1Gbps or 10Gbps) and must terminate at the same Direct Connect endpoint.
You can have up to 10 dedicated connections per LAG. Regardless of this limit, if you request more connections for the LAG than Direct Connect can allocate on a single endpoint, no LAG is created.
You can specify an existing physical dedicated connection or interconnect to include in the LAG (which counts towards the total number of connections). Doing so interrupts the current physical dedicated connection, and re-establishes them as a member of the LAG. The LAG will be created on the same Direct Connect endpoint to which the dedicated connection terminates. Any virtual interfaces associated with the dedicated connection are automatically disassociated and re-associated with the LAG. The connection ID does not change.
If the account used to create a LAG is a registered Direct Connect Partner, the LAG is automatically enabled to host sub-connections. For a LAG owned by a partner, any associated virtual interfaces cannot be directly configured.
", - "CreatePrivateVirtualInterface": "Creates a private virtual interface. A virtual interface is the VLAN that transports Direct Connect traffic. A private virtual interface can be connected to either a Direct Connect gateway or a Virtual Private Gateway (VGW). Connecting the private virtual interface to a Direct Connect gateway enables the possibility for connecting to multiple VPCs, including VPCs in different Regions. Connecting the private virtual interface to a VGW only provides access to a single VPC within the same Region.
Setting the MTU of a virtual interface to 9001 (jumbo frames) can cause an update to the underlying physical connection if it wasn't updated to support jumbo frames. Updating the connection disrupts network connectivity for all virtual interfaces associated with the connection for up to 30 seconds. To check whether your connection supports jumbo frames, call DescribeConnections. To check whether your virtual interface supports jumbo frames, call DescribeVirtualInterfaces.
", + "CreateLag": "Creates a link aggregation group (LAG) with the specified number of bundled physical dedicated connections between the customer network and a specific Direct Connect location. A LAG is a logical interface that uses the Link Aggregation Control Protocol (LACP) to aggregate multiple interfaces, enabling you to treat them as a single interface.
All connections in a LAG must use the same bandwidth (either 1Gbps or 10Gbps) and must terminate at the same Direct Connect endpoint.
You can have up to 10 dedicated connections per LAG. Regardless of this limit, if you request more connections for the LAG than Direct Connect can allocate on a single endpoint, no LAG is created.
You can specify an existing physical dedicated connection or interconnect to include in the LAG (which counts towards the total number of connections). Doing so interrupts the current physical dedicated connection, and re-establishes them as a member of the LAG. The LAG will be created on the same Direct Connect endpoint to which the dedicated connection terminates. Any virtual interfaces associated with the dedicated connection are automatically disassociated and re-associated with the LAG. The connection ID does not change.
If the Amazon Web Services account used to create a LAG is a registered Direct Connect Partner, the LAG is automatically enabled to host sub-connections. For a LAG owned by a partner, any associated virtual interfaces cannot be directly configured.
", + "CreatePrivateVirtualInterface": "Creates a private virtual interface. A virtual interface is the VLAN that transports Direct Connect traffic. A private virtual interface can be connected to either a Direct Connect gateway or a Virtual Private Gateway (VGW). Connecting the private virtual interface to a Direct Connect gateway enables the possibility for connecting to multiple VPCs, including VPCs in different Amazon Web Services Regions. Connecting the private virtual interface to a VGW only provides access to a single VPC within the same Region.
Setting the MTU of a virtual interface to 9001 (jumbo frames) can cause an update to the underlying physical connection if it wasn't updated to support jumbo frames. Updating the connection disrupts network connectivity for all virtual interfaces associated with the connection for up to 30 seconds. To check whether your connection supports jumbo frames, call DescribeConnections. To check whether your virtual interface supports jumbo frames, call DescribeVirtualInterfaces.
", "CreatePublicVirtualInterface": "Creates a public virtual interface. A virtual interface is the VLAN that transports Direct Connect traffic. A public virtual interface supports sending traffic to public services of Amazon Web Services such as Amazon S3.
When creating an IPv6 public virtual interface (addressFamily is ipv6), leave the customer and amazon address fields blank to use auto-assigned IPv6 space. Custom IPv6 addresses are not supported.
Creates a transit virtual interface. A transit virtual interface should be used to access one or more transit gateways associated with Direct Connect gateways. A transit virtual interface enables the connection of multiple VPCs attached to a transit gateway to a Direct Connect gateway.
If you associate your transit gateway with one or more Direct Connect gateways, the Autonomous System Number (ASN) used by the transit gateway and the Direct Connect gateway must be different. For example, if you use the default ASN 64512 for both your the transit gateway and Direct Connect gateway, the association request fails.
Setting the MTU of a virtual interface to 8500 (jumbo frames) can cause an update to the underlying physical connection if it wasn't updated to support jumbo frames. Updating the connection disrupts network connectivity for all virtual interfaces associated with the connection for up to 30 seconds. To check whether your connection supports jumbo frames, call DescribeConnections. To check whether your virtual interface supports jumbo frames, call DescribeVirtualInterfaces.
", "DeleteBGPPeer": "Deletes the specified BGP peer on the specified virtual interface with the specified customer address and ASN.
You cannot delete the last BGP peer from a virtual interface.
", @@ -37,19 +38,21 @@ "DescribeConnectionLoa": "Deprecated. Use DescribeLoa instead.
Gets the LOA-CFA for a connection.
The Letter of Authorization - Connecting Facility Assignment (LOA-CFA) is a document that your APN partner or service provider uses when establishing your cross connect to Amazon Web Services at the colocation facility. For more information, see Requesting Cross Connects at Direct Connect Locations in the Direct Connect User Guide.
", "DescribeConnections": "Displays the specified connection or all connections in this Region.
", "DescribeConnectionsOnInterconnect": "Deprecated. Use DescribeHostedConnections instead.
Lists the connections that have been provisioned on the specified interconnect.
Intended for use by Direct Connect Partners only.
Get and view a list of customer agreements, along with their signed status and whether the customer is an NNIPartner, NNIPartnerV2, or a nonPartner.
", "DescribeDirectConnectGatewayAssociationProposals": "Describes one or more association proposals for connection between a virtual private gateway or transit gateway and a Direct Connect gateway.
", "DescribeDirectConnectGatewayAssociations": "Lists the associations between your Direct Connect gateways and virtual private gateways and transit gateways. You must specify one of the following:
A Direct Connect gateway
The response contains all virtual private gateways and transit gateways associated with the Direct Connect gateway.
A virtual private gateway
The response contains the Direct Connect gateway.
A transit gateway
The response contains the Direct Connect gateway.
A Direct Connect gateway and a virtual private gateway
The response contains the association between the Direct Connect gateway and virtual private gateway.
A Direct Connect gateway and a transit gateway
The response contains the association between the Direct Connect gateway and transit gateway.
Lists the attachments between your Direct Connect gateways and virtual interfaces. You must specify a Direct Connect gateway, a virtual interface, or both. If you specify a Direct Connect gateway, the response contains all virtual interfaces attached to the Direct Connect gateway. If you specify a virtual interface, the response contains all Direct Connect gateways attached to the virtual interface. If you specify both, the response contains the attachment between the Direct Connect gateway and the virtual interface.
", "DescribeDirectConnectGateways": "Lists all your Direct Connect gateways or only the specified Direct Connect gateway. Deleted Direct Connect gateways are not returned.
", "DescribeHostedConnections": "Lists the hosted connections that have been provisioned on the specified interconnect or link aggregation group (LAG).
Intended for use by Direct Connect Partners only.
Deprecated. Use DescribeLoa instead.
Gets the LOA-CFA for the specified interconnect.
The Letter of Authorization - Connecting Facility Assignment (LOA-CFA) is a document that is used when establishing your cross connect to Amazon Web Services at the colocation facility. For more information, see Requesting Cross Connects at Direct Connect Locations in the Direct Connect User Guide.
", - "DescribeInterconnects": "Lists the interconnects owned by the account or only the specified interconnect.
", + "DescribeInterconnects": "Lists the interconnects owned by the Amazon Web Services account or only the specified interconnect.
", "DescribeLags": "Describes all your link aggregation groups (LAG) or the specified LAG.
", "DescribeLoa": "Gets the LOA-CFA for a connection, interconnect, or link aggregation group (LAG).
The Letter of Authorization - Connecting Facility Assignment (LOA-CFA) is a document that is used when establishing your cross connect to Amazon Web Services at the colocation facility. For more information, see Requesting Cross Connects at Direct Connect Locations in the Direct Connect User Guide.
", - "DescribeLocations": "Lists the Direct Connect locations in the current Region. These are the locations that can be selected when calling CreateConnection or CreateInterconnect.
", + "DescribeLocations": "Lists the Direct Connect locations in the current Amazon Web Services Region. These are the locations that can be selected when calling CreateConnection or CreateInterconnect.
", + "DescribeRouterConfiguration": "Details about the router.
", "DescribeTags": "Describes the tags associated with the specified Direct Connect resources.
", - "DescribeVirtualGateways": "Lists the virtual private gateways owned by the account.
You can create one or more Direct Connect private virtual interfaces linked to a virtual private gateway.
", - "DescribeVirtualInterfaces": "Displays all virtual interfaces for an account. Virtual interfaces deleted fewer than 15 minutes before you make the request are also returned. If you specify a connection ID, only the virtual interfaces associated with the connection are returned. If you specify a virtual interface ID, then only a single virtual interface is returned.
A virtual interface (VLAN) transmits the traffic between the Direct Connect location and the customer network.
", + "DescribeVirtualGateways": "Lists the virtual private gateways owned by the Amazon Web Services account.
You can create one or more Direct Connect private virtual interfaces linked to a virtual private gateway.
", + "DescribeVirtualInterfaces": "Displays all virtual interfaces for an Amazon Web Services account. Virtual interfaces deleted fewer than 15 minutes before you make the request are also returned. If you specify a connection ID, only the virtual interfaces associated with the connection are returned. If you specify a virtual interface ID, then only a single virtual interface is returned.
A virtual interface (VLAN) transmits the traffic between the Direct Connect location and the customer network.
", "DisassociateConnectionFromLag": "Disassociates a connection from a link aggregation group (LAG). The connection is interrupted and re-established as a standalone connection (the connection is not deleted; to delete the connection, use the DeleteConnection request). If the LAG has associated virtual interfaces or hosted connections, they remain associated with the LAG. A disassociated connection owned by an Direct Connect Partner is automatically converted to an interconnect.
If disassociating the connection would cause the LAG to fall below its setting for minimum number of operational connections, the request fails, except when it's the last member of the LAG. If all connections are disassociated, the LAG continues to exist as an empty LAG with no physical connections.
", "DisassociateMacSecKey": "Removes the association between a MAC Security (MACsec) security key and an Direct Connect dedicated connection.
", "ListVirtualInterfaceTestHistory": "Lists the virtual interface failover test history.
", @@ -58,6 +61,7 @@ "TagResource": "Adds the specified tags to the specified Direct Connect resource. Each resource can have a maximum of 50 tags.
Each tag consists of a key and an optional value. If a tag with the same key is already associated with the resource, this action updates its value.
", "UntagResource": "Removes one or more tags from the specified Direct Connect resource.
", "UpdateConnection": "Updates the Direct Connect dedicated connection configuration.
You can update the following parameters for a connection:
The connection name
The connection's MAC Security (MACsec) encryption mode.
Updates the name of a current Direct Connect gateway.
", "UpdateDirectConnectGatewayAssociation": "Updates the specified attributes of the Direct Connect gateway association.
Add or remove prefixes from the association.
", "UpdateLag": "Updates the attributes of the specified link aggregation group (LAG).
You can update the following LAG attributes:
The name of the LAG.
The value for the minimum number of connections that must be operational for the LAG itself to be operational.
The LAG's MACsec encryption mode.
Amazon Web Services assigns this value to each connection which is part of the LAG.
The tags
If you adjust the threshold value for the minimum number of operational connections, ensure that the new value does not cause the LAG to fall below the threshold and become non-operational.
Updates the specified attributes of the specified virtual private interface.
Setting the MTU of a virtual interface to 9001 (jumbo frames) can cause an update to the underlying physical connection if it wasn't updated to support jumbo frames. Updating the connection disrupts network connectivity for all virtual interfaces associated with the connection for up to 30 seconds. To check whether your connection supports jumbo frames, call DescribeConnections. To check whether your virtual q interface supports jumbo frames, call DescribeVirtualInterfaces.
" @@ -102,6 +106,19 @@ "VirtualInterface$addressFamily": "The address family for the BGP peer.
" } }, + "AgreementList": { + "base": null, + "refs": { + "DescribeCustomerMetadataResponse$agreements": "The list of customer agreements.
" + } + }, + "AgreementName": { + "base": null, + "refs": { + "ConfirmCustomerAgreementRequest$agreementName": "The name of the customer agreement.
", + "CustomerAgreement$agreementName": "The name of the agreement.
" + } + }, "AllocateConnectionOnInterconnectRequest": { "base": null, "refs": { @@ -327,6 +344,16 @@ "refs": { } }, + "ConfirmCustomerAgreementRequest": { + "base": null, + "refs": { + } + }, + "ConfirmCustomerAgreementResponse": { + "base": null, + "refs": { + } + }, "ConfirmPrivateVirtualInterfaceRequest": { "base": null, "refs": { @@ -523,6 +550,12 @@ "VirtualInterface$customerAddress": "The IP address assigned to the customer interface.
" } }, + "CustomerAgreement": { + "base": "The name and status of a customer agreement.
", + "refs": { + "AgreementList$member": null + } + }, "DeleteBGPPeerRequest": { "base": null, "refs": { @@ -613,6 +646,11 @@ "refs": { } }, + "DescribeCustomerMetadataResponse": { + "base": null, + "refs": { + } + }, "DescribeDirectConnectGatewayAssociationProposalsRequest": { "base": null, "refs": { @@ -683,6 +721,16 @@ "refs": { } }, + "DescribeRouterConfigurationRequest": { + "base": "Provides the details about a virtual interface's router.
", + "refs": { + } + }, + "DescribeRouterConfigurationResponse": { + "base": null, + "refs": { + } + }, "DescribeTagsRequest": { "base": null, "refs": { @@ -708,7 +756,8 @@ "refs": { "CreateDirectConnectGatewayResult$directConnectGateway": "The Direct Connect gateway.
", "DeleteDirectConnectGatewayResult$directConnectGateway": "The Direct Connect gateway.
", - "DirectConnectGatewayList$member": null + "DirectConnectGatewayList$member": null, + "UpdateDirectConnectGatewayResponse$directConnectGateway": null } }, "DirectConnectGatewayAssociation": { @@ -815,6 +864,7 @@ "DirectConnectGatewayAttachment$directConnectGatewayId": "The ID of the Direct Connect gateway.
", "NewPrivateVirtualInterface$directConnectGatewayId": "The ID of the Direct Connect gateway.
", "NewTransitVirtualInterface$directConnectGatewayId": "The ID of the Direct Connect gateway.
", + "UpdateDirectConnectGatewayRequest$directConnectGatewayId": "The ID of the Direct Connect gateway to update.
", "VirtualInterface$directConnectGatewayId": "The ID of the Direct Connect gateway.
" } }, @@ -828,7 +878,8 @@ "base": null, "refs": { "CreateDirectConnectGatewayRequest$directConnectGatewayName": "The name of the Direct Connect gateway.
", - "DirectConnectGateway$directConnectGatewayName": "The name of the Direct Connect gateway.
" + "DirectConnectGateway$directConnectGatewayName": "The name of the Direct Connect gateway.
", + "UpdateDirectConnectGatewayRequest$newDirectConnectGatewayName": "The new name for the Direct Connect gateway.
" } }, "DirectConnectGatewayState": { @@ -1183,25 +1234,31 @@ "AllocateTransitVirtualInterfaceRequest$newTransitVirtualInterfaceAllocation": "Information about the transit virtual interface.
" } }, + "NniPartnerType": { + "base": null, + "refs": { + "DescribeCustomerMetadataResponse$nniPartnerType": "The type of network-to-network interface (NNI) partner. The partner type will be one of the following:
V1: This partner can only allocate 50Mbps, 100Mbps, 200Mbps, 300Mbps, 400Mbps, or 500Mbps subgigabit connections.
V2: This partner can only allocate 1GB, 2GB, 5GB, or 10GB hosted connections.
nonPartner: The customer is not a partner.
The ID of the account that owns the virtual private gateway or transit gateway.
", - "AllocateConnectionOnInterconnectRequest$ownerAccount": "The ID of the account of the customer for whom the connection will be provisioned.
", - "AllocateHostedConnectionRequest$ownerAccount": "The ID of the account ID of the customer for the connection.
", - "AllocatePrivateVirtualInterfaceRequest$ownerAccount": "The ID of the account that owns the virtual private interface.
", - "AllocatePublicVirtualInterfaceRequest$ownerAccount": "The ID of the account that owns the public virtual interface.
", - "AllocateTransitVirtualInterfaceRequest$ownerAccount": "The ID of the account that owns the transit virtual interface.
", - "AssociatedGateway$ownerAccount": "The ID of the account that owns the associated virtual private gateway or transit gateway.
", - "Connection$ownerAccount": "The ID of the account that owns the connection.
", - "CreateDirectConnectGatewayAssociationProposalRequest$directConnectGatewayOwnerAccount": "The ID of the account that owns the Direct Connect gateway.
", - "DirectConnectGateway$ownerAccount": "The ID of the account that owns the Direct Connect gateway.
", - "DirectConnectGatewayAssociation$directConnectGatewayOwnerAccount": "The ID of the account that owns the associated gateway.
", - "DirectConnectGatewayAssociation$virtualGatewayOwnerAccount": "The ID of the account that owns the virtual private gateway.
", - "DirectConnectGatewayAssociationProposal$directConnectGatewayOwnerAccount": "The ID of the account that owns the Direct Connect gateway.
", - "DirectConnectGatewayAttachment$virtualInterfaceOwnerAccount": "The ID of the account that owns the virtual interface.
", - "Lag$ownerAccount": "The ID of the account that owns the LAG.
", - "VirtualInterface$ownerAccount": "The ID of the account that owns the virtual interface.
", + "AcceptDirectConnectGatewayAssociationProposalRequest$associatedGatewayOwnerAccount": "The ID of the Amazon Web Services account that owns the virtual private gateway or transit gateway.
", + "AllocateConnectionOnInterconnectRequest$ownerAccount": "The ID of the Amazon Web Services account of the customer for whom the connection will be provisioned.
", + "AllocateHostedConnectionRequest$ownerAccount": "The ID of the Amazon Web Services account ID of the customer for the connection.
", + "AllocatePrivateVirtualInterfaceRequest$ownerAccount": "The ID of the Amazon Web Services account that owns the virtual private interface.
", + "AllocatePublicVirtualInterfaceRequest$ownerAccount": "The ID of the Amazon Web Services account that owns the public virtual interface.
", + "AllocateTransitVirtualInterfaceRequest$ownerAccount": "The ID of the Amazon Web Services account that owns the transit virtual interface.
", + "AssociatedGateway$ownerAccount": "The ID of the Amazon Web Services account that owns the associated virtual private gateway or transit gateway.
", + "Connection$ownerAccount": "The ID of the Amazon Web Services account that owns the connection.
", + "CreateDirectConnectGatewayAssociationProposalRequest$directConnectGatewayOwnerAccount": "The ID of the Amazon Web Services account that owns the Direct Connect gateway.
", + "DirectConnectGateway$ownerAccount": "The ID of the Amazon Web Services account that owns the Direct Connect gateway.
", + "DirectConnectGatewayAssociation$directConnectGatewayOwnerAccount": "The ID of the Amazon Web Services account that owns the associated gateway.
", + "DirectConnectGatewayAssociation$virtualGatewayOwnerAccount": "The ID of the Amazon Web Services account that owns the virtual private gateway.
", + "DirectConnectGatewayAssociationProposal$directConnectGatewayOwnerAccount": "The ID of the Amazon Web Services account that owns the Direct Connect gateway.
", + "DirectConnectGatewayAttachment$virtualInterfaceOwnerAccount": "The ID of the Amazon Web Services account that owns the virtual interface.
", + "Lag$ownerAccount": "The ID of the Amazon Web Services account that owns the LAG.
", + "VirtualInterface$ownerAccount": "The ID of the Amazon Web Services account that owns the virtual interface.
", "VirtualInterfaceTestHistory$ownerAccount": "The owner ID of the tested virtual interface.
" } }, @@ -1226,6 +1283,12 @@ "Connection$partnerName": "The name of the Direct Connect service provider associated with the connection.
" } }, + "Platform": { + "base": null, + "refs": { + "RouterType$platform": "The virtual interface router platform.
" + } + }, "PortEncryptionStatus": { "base": null, "refs": { @@ -1264,11 +1327,11 @@ "base": null, "refs": { "AssociatedGateway$region": "The Region where the associated gateway is located.
", - "Connection$region": "The Region where the connection is located.
", - "Interconnect$region": "The Region where the connection is located.
", - "Lag$region": "The Region where the connection is located.
", - "Location$region": "The Region for the location.
", - "VirtualInterface$region": "The Region where the virtual interface is located.
" + "Connection$region": "The Amazon Web Services Region where the connection is located.
", + "Interconnect$region": "The Amazon Web Services Region where the connection is located.
", + "Lag$region": "The Amazon Web Services Region where the connection is located.
", + "Location$region": "The Amazon Web Services Region for the location.
", + "VirtualInterface$region": "The Amazon Web Services Region where the virtual interface is located.
" } }, "RequestMACSec": { @@ -1331,9 +1394,23 @@ "RouterConfig": { "base": null, "refs": { + "DescribeRouterConfigurationResponse$customerRouterConfig": "The customer router configuration.
", "VirtualInterface$customerRouterConfig": "The customer router configuration.
" } }, + "RouterType": { + "base": "Information about the virtual router.
", + "refs": { + "DescribeRouterConfigurationResponse$router": "The details about the router.
" + } + }, + "RouterTypeIdentifier": { + "base": null, + "refs": { + "DescribeRouterConfigurationRequest$routerTypeIdentifier": "Identifies the router by a combination of vendor, platform, and software version. For example, CiscoSystemsInc-2900SeriesRouters-IOS124.
Identifies the router by a combination of vendor, platform, and software version. For example, CiscoSystemsInc-2900SeriesRouters-IOS124.
The Amazon Resource Name (ARN) of the MAC Security (MACsec) secret key.
" } }, + "Software": { + "base": null, + "refs": { + "RouterType$software": "The router software.
" + } + }, "StartBgpFailoverTestRequest": { "base": null, "refs": { @@ -1378,6 +1461,13 @@ "DirectConnectGatewayAttachment$stateChangeError": "The error message if the state of an object failed to advance.
" } }, + "Status": { + "base": null, + "refs": { + "ConfirmCustomerAgreementResponse$status": " The status of the customer agreement when the connection was created. This will be either signed or unsigned.
The status of the customer agreement. This will be either signed or unsigned
The ID of the VLAN.
" } }, + "Vendor": { + "base": null, + "refs": { + "RouterType$vendor": "The vendor for the virtual interface's router.
" + } + }, "VirtualGateway": { "base": "Information about a virtual private gateway for a private virtual interface.
", "refs": { @@ -1542,7 +1648,7 @@ "VirtualGatewayRegion": { "base": null, "refs": { - "DirectConnectGatewayAssociation$virtualGatewayRegion": "The Region where the virtual private gateway is located.
" + "DirectConnectGatewayAssociation$virtualGatewayRegion": "The Amazon Web Services Region where the virtual private gateway is located.
" } }, "VirtualGatewayState": { @@ -1577,6 +1683,8 @@ "DeleteBGPPeerRequest$virtualInterfaceId": "The ID of the virtual interface.
", "DeleteVirtualInterfaceRequest$virtualInterfaceId": "The ID of the virtual interface.
", "DescribeDirectConnectGatewayAttachmentsRequest$virtualInterfaceId": "The ID of the virtual interface.
", + "DescribeRouterConfigurationRequest$virtualInterfaceId": "The ID of the virtual interface.
", + "DescribeRouterConfigurationResponse$virtualInterfaceId": "The ID assigned to the virtual interface.
", "DescribeVirtualInterfacesRequest$virtualInterfaceId": "The ID of the virtual interface.
", "DirectConnectGatewayAttachment$virtualInterfaceId": "The ID of the virtual interface.
", "ListVirtualInterfaceTestHistoryRequest$virtualInterfaceId": "The ID of the virtual interface that was tested.
", @@ -1596,6 +1704,7 @@ "VirtualInterfaceName": { "base": null, "refs": { + "DescribeRouterConfigurationResponse$virtualInterfaceName": "The name of the virtual interface assigned by the customer network.
", "NewPrivateVirtualInterface$virtualInterfaceName": "The name of the virtual interface assigned by the customer network. The name has a maximum of 100 characters. The following are valid characters: a-z, 0-9 and a hyphen (-).
", "NewPrivateVirtualInterfaceAllocation$virtualInterfaceName": "The name of the virtual interface assigned by the customer network. The name has a maximum of 100 characters. The following are valid characters: a-z, 0-9 and a hyphen (-).
", "NewPublicVirtualInterface$virtualInterfaceName": "The name of the virtual interface assigned by the customer network. The name has a maximum of 100 characters. The following are valid characters: a-z, 0-9 and a hyphen (-).
", @@ -1608,7 +1717,7 @@ "VirtualInterfaceRegion": { "base": null, "refs": { - "DirectConnectGatewayAttachment$virtualInterfaceRegion": "The Region where the virtual interface is located.
" + "DirectConnectGatewayAttachment$virtualInterfaceRegion": "The Amazon Web Services Region where the virtual interface is located.
" } }, "VirtualInterfaceState": { @@ -1645,6 +1754,18 @@ "base": null, "refs": { } + }, + "XsltTemplateName": { + "base": null, + "refs": { + "RouterType$xsltTemplateName": "The template for the virtual interface's router.
" + } + }, + "XsltTemplateNameForMacSec": { + "base": null, + "refs": { + "RouterType$xsltTemplateNameForMacSec": "The MAC Security (MACsec) template for the virtual interface's router.
" + } } } } diff --git a/models/apis/mediaconvert/2017-08-29/api-2.json b/models/apis/mediaconvert/2017-08-29/api-2.json index 1e604604d9..e4aca3c586 100644 --- a/models/apis/mediaconvert/2017-08-29/api-2.json +++ b/models/apis/mediaconvert/2017-08-29/api-2.json @@ -4215,9 +4215,20 @@ "TimeDelta": { "shape": "__integerMinNegative2147483648Max2147483647", "locationName": "timeDelta" + }, + "TimeDeltaUnits": { + "shape": "FileSourceTimeDeltaUnits", + "locationName": "timeDeltaUnits" } } }, + "FileSourceTimeDeltaUnits": { + "type": "string", + "enum": [ + "SECONDS", + "MILLISECONDS" + ] + }, "FontScript": { "type": "string", "enum": [ diff --git a/models/apis/mediaconvert/2017-08-29/docs-2.json b/models/apis/mediaconvert/2017-08-29/docs-2.json index e1852a8bdf..0851aa61c4 100644 --- a/models/apis/mediaconvert/2017-08-29/docs-2.json +++ b/models/apis/mediaconvert/2017-08-29/docs-2.json @@ -432,63 +432,63 @@ } }, "BurnInSubtitleStylePassthrough": { - "base": "Ignore this setting unless your output captions are burned in. Choose which set of style and position values the service applies to your output captions. When you choose ENABLED, the service uses the input style and position information from your input. When you choose DISABLED, the service uses any style values that you specify in your output settings. If you don't specify values, the service uses default style and position values. When you choose DISABLED, the service ignores all style and position values from your input.", + "base": "Set Style passthrough (StylePassthrough) to ENABLED to use the available style, color, and position information from your input captions. MediaConvert uses default settings for any missing style and position information in your input captions. Set Style passthrough to DISABLED, or leave blank, to ignore the style and position information from your input captions and use default settings: white text with black outlining, bottom-center positioning, and automatic sizing. Whether you set Style passthrough to enabled or not, you can also choose to manually override any of the individual style and position settings.", "refs": { - "BurninDestinationSettings$StylePassthrough": "Ignore this setting unless your output captions are burned in. Choose which set of style and position values the service applies to your output captions. When you choose ENABLED, the service uses the input style and position information from your input. When you choose DISABLED, the service uses any style values that you specify in your output settings. If you don't specify values, the service uses default style and position values. When you choose DISABLED, the service ignores all style and position values from your input." + "BurninDestinationSettings$StylePassthrough": "Set Style passthrough (StylePassthrough) to ENABLED to use the available style, color, and position information from your input captions. MediaConvert uses default settings for any missing style and position information in your input captions. Set Style passthrough to DISABLED, or leave blank, to ignore the style and position information from your input captions and use default settings: white text with black outlining, bottom-center positioning, and automatic sizing. Whether you set Style passthrough to enabled or not, you can also choose to manually override any of the individual style and position settings." } }, "BurninDestinationSettings": { - "base": "Settings related to burn-in captions. Set up burn-in captions in the same output as your video. For more information, see https://docs.aws.amazon.com/mediaconvert/latest/ug/burn-in-output-captions.html. When you work directly in your JSON job specification, include this object and any required children when you set destinationType to BURN_IN.", + "base": "Burn-in is a captions delivery method, rather than a captions format. Burn-in writes the captions directly on your video frames, replacing pixels of video content with the captions. Set up burn-in captions in the same output as your video. For more information, see https://docs.aws.amazon.com/mediaconvert/latest/ug/burn-in-output-captions.html. When you work directly in your JSON job specification, include this object and any required children when you set destinationType to BURN_IN.", "refs": { - "CaptionDestinationSettings$BurninDestinationSettings": "Settings related to burn-in captions. Set up burn-in captions in the same output as your video. For more information, see https://docs.aws.amazon.com/mediaconvert/latest/ug/burn-in-output-captions.html. When you work directly in your JSON job specification, include this object and any required children when you set destinationType to BURN_IN." + "CaptionDestinationSettings$BurninDestinationSettings": "Burn-in is a captions delivery method, rather than a captions format. Burn-in writes the captions directly on your video frames, replacing pixels of video content with the captions. Set up burn-in captions in the same output as your video. For more information, see https://docs.aws.amazon.com/mediaconvert/latest/ug/burn-in-output-captions.html. When you work directly in your JSON job specification, include this object and any required children when you set destinationType to BURN_IN." } }, "BurninSubtitleAlignment": { - "base": "If no explicit x_position or y_position is provided, setting alignment to centered will place the captions at the bottom center of the output. Similarly, setting a left alignment will align captions to the bottom left of the output. If x and y positions are given in conjunction with the alignment parameter, the font will be justified (either left or centered) relative to those coordinates. This option is not valid for source captions that are STL, 608/embedded or teletext. These source settings are already pre-defined by the caption stream. All burn-in and DVB-Sub font settings must match.", + "base": "Specify the alignment of your captions. If no explicit x_position is provided, setting alignment to centered will placethe captions at the bottom center of the output. Similarly, setting a left alignment willalign captions to the bottom left of the output. If x and y positions are given in conjunction with the alignment parameter, the font will be justified (either left or centered) relative to those coordinates.", "refs": { - "BurninDestinationSettings$Alignment": "If no explicit x_position or y_position is provided, setting alignment to centered will place the captions at the bottom center of the output. Similarly, setting a left alignment will align captions to the bottom left of the output. If x and y positions are given in conjunction with the alignment parameter, the font will be justified (either left or centered) relative to those coordinates. This option is not valid for source captions that are STL, 608/embedded or teletext. These source settings are already pre-defined by the caption stream. All burn-in and DVB-Sub font settings must match." + "BurninDestinationSettings$Alignment": "Specify the alignment of your captions. If no explicit x_position is provided, setting alignment to centered will placethe captions at the bottom center of the output. Similarly, setting a left alignment willalign captions to the bottom left of the output. If x and y positions are given in conjunction with the alignment parameter, the font will be justified (either left or centered) relative to those coordinates." } }, "BurninSubtitleApplyFontColor": { - "base": "Ignore this setting unless your input captions are STL, any type of 608, teletext, or TTML, and your output captions are burned in. Specify how the service applies the color specified in the setting Font color (BurninSubtitleFontColor). By default, this color is white. When you choose WHITE_TEXT_ONLY, the service uses the specified font color only for text that is white in the input. When you choose ALL_TEXT, the service uses the specified font color for all output captions text. If you leave both settings at their default value, your output font color is the same as your input font color.", + "base": "Ignore this setting unless Style passthrough (StylePassthrough) is set to Enabled and Font color (FontColor) set to Black, Yellow, Red, Green, Blue, or Hex. Use Apply font color (ApplyFontColor) for additional font color controls. When you choose White text only (WHITE_TEXT_ONLY), or leave blank, your font color setting only applies to white text in your input captions. For example, if your font color setting is Yellow, and your input captions have red and white text, your output captions will have red and yellow text. When you choose ALL_TEXT, your font color setting applies to all of your output captions text.", "refs": { - "BurninDestinationSettings$ApplyFontColor": "Ignore this setting unless your input captions are STL, any type of 608, teletext, or TTML, and your output captions are burned in. Specify how the service applies the color specified in the setting Font color (BurninSubtitleFontColor). By default, this color is white. When you choose WHITE_TEXT_ONLY, the service uses the specified font color only for text that is white in the input. When you choose ALL_TEXT, the service uses the specified font color for all output captions text. If you leave both settings at their default value, your output font color is the same as your input font color." + "BurninDestinationSettings$ApplyFontColor": "Ignore this setting unless Style passthrough (StylePassthrough) is set to Enabled and Font color (FontColor) set to Black, Yellow, Red, Green, Blue, or Hex. Use Apply font color (ApplyFontColor) for additional font color controls. When you choose White text only (WHITE_TEXT_ONLY), or leave blank, your font color setting only applies to white text in your input captions. For example, if your font color setting is Yellow, and your input captions have red and white text, your output captions will have red and yellow text. When you choose ALL_TEXT, your font color setting applies to all of your output captions text." } }, "BurninSubtitleBackgroundColor": { - "base": "Specifies the color of the rectangle behind the captions.\nAll burn-in and DVB-Sub font settings must match.", + "base": "Specify the color of the rectangle behind the captions. Leave background color (BackgroundColor) blank and set Style passthrough (StylePassthrough) to enabled to use the background color data from your input captions, if present. Within your job settings, all of your DVB-Sub settings must be identical.", "refs": { - "BurninDestinationSettings$BackgroundColor": "Specifies the color of the rectangle behind the captions.\nAll burn-in and DVB-Sub font settings must match." + "BurninDestinationSettings$BackgroundColor": "Specify the color of the rectangle behind the captions. Leave background color (BackgroundColor) blank and set Style passthrough (StylePassthrough) to enabled to use the background color data from your input captions, if present. Within your job settings, all of your DVB-Sub settings must be identical." } }, "BurninSubtitleFallbackFont": { - "base": "Specify the font that you want the service to use for your burn in captions when your input captions specify a font that MediaConvert doesn't support. When you keep the default value, Best match (BEST_MATCH), MediaConvert uses a supported font that most closely matches the font that your input captions specify. When there are multiple unsupported fonts in your input captions, MediaConvert matches each font with the supported font that matches best. When you explicitly choose a replacement font, MediaConvert uses that font to replace all unsupported fonts from your input.", + "base": "Specify the font that you want the service to use for your burn in captions when your input captions specify a font that MediaConvert doesn't support. When you set Fallback font (FallbackFont) to best match (BEST_MATCH), or leave blank, MediaConvert uses a supported font that most closely matches the font that your input captions specify. When there are multiple unsupported fonts in your input captions, MediaConvert matches each font with the supported font that matches best. When you explicitly choose a replacement font, MediaConvert uses that font to replace all unsupported fonts from your input.", "refs": { - "BurninDestinationSettings$FallbackFont": "Specify the font that you want the service to use for your burn in captions when your input captions specify a font that MediaConvert doesn't support. When you keep the default value, Best match (BEST_MATCH), MediaConvert uses a supported font that most closely matches the font that your input captions specify. When there are multiple unsupported fonts in your input captions, MediaConvert matches each font with the supported font that matches best. When you explicitly choose a replacement font, MediaConvert uses that font to replace all unsupported fonts from your input." + "BurninDestinationSettings$FallbackFont": "Specify the font that you want the service to use for your burn in captions when your input captions specify a font that MediaConvert doesn't support. When you set Fallback font (FallbackFont) to best match (BEST_MATCH), or leave blank, MediaConvert uses a supported font that most closely matches the font that your input captions specify. When there are multiple unsupported fonts in your input captions, MediaConvert matches each font with the supported font that matches best. When you explicitly choose a replacement font, MediaConvert uses that font to replace all unsupported fonts from your input." } }, "BurninSubtitleFontColor": { - "base": "Specifies the color of the burned-in captions. This option is not valid for source captions that are STL, 608/embedded or teletext. These source settings are already pre-defined by the caption stream. All burn-in and DVB-Sub font settings must match.", + "base": "Specify the color of the burned-in captions text. Leave Font color (FontColor) blank and set Style passthrough (StylePassthrough) to enabled to use the font color data from your input captions, if present.", "refs": { - "BurninDestinationSettings$FontColor": "Specifies the color of the burned-in captions. This option is not valid for source captions that are STL, 608/embedded or teletext. These source settings are already pre-defined by the caption stream. All burn-in and DVB-Sub font settings must match." + "BurninDestinationSettings$FontColor": "Specify the color of the burned-in captions text. Leave Font color (FontColor) blank and set Style passthrough (StylePassthrough) to enabled to use the font color data from your input captions, if present." } }, "BurninSubtitleOutlineColor": { - "base": "Specifies font outline color. This option is not valid for source captions that are either 608/embedded or teletext. These source settings are already pre-defined by the caption stream. All burn-in and DVB-Sub font settings must match.", + "base": "Specify font outline color. Leave Outline color (OutlineColor) blank and set Style passthrough (StylePassthrough) to enabled to use the font outline color data from your input captions, if present.", "refs": { - "BurninDestinationSettings$OutlineColor": "Specifies font outline color. This option is not valid for source captions that are either 608/embedded or teletext. These source settings are already pre-defined by the caption stream. All burn-in and DVB-Sub font settings must match." + "BurninDestinationSettings$OutlineColor": "Specify font outline color. Leave Outline color (OutlineColor) blank and set Style passthrough (StylePassthrough) to enabled to use the font outline color data from your input captions, if present." } }, "BurninSubtitleShadowColor": { - "base": "Specifies the color of the shadow cast by the captions.\nAll burn-in and DVB-Sub font settings must match.", + "base": "Specify the color of the shadow cast by the captions. Leave Shadow color (ShadowColor) blank and set Style passthrough (StylePassthrough) to enabled to use the shadow color data from your input captions, if present.", "refs": { - "BurninDestinationSettings$ShadowColor": "Specifies the color of the shadow cast by the captions.\nAll burn-in and DVB-Sub font settings must match." + "BurninDestinationSettings$ShadowColor": "Specify the color of the shadow cast by the captions. Leave Shadow color (ShadowColor) blank and set Style passthrough (StylePassthrough) to enabled to use the shadow color data from your input captions, if present." } }, "BurninSubtitleTeletextSpacing": { - "base": "Only applies to jobs with input captions in Teletext or STL formats. Specify whether the spacing between letters in your captions is set by the captions grid or varies depending on letter width. Choose fixed grid to conform to the spacing specified in the captions file more accurately. Choose proportional to make the text easier to read if the captions are closed caption.", + "base": "Specify whether the text spacing (TeletextSpacing) in your captions is set by the captions grid, or varies depending on letter width. Choose fixed grid (FIXED_GRID) to conform to the spacing specified in the captions file more accurately. Choose proportional (PROPORTIONAL) to make the text easier to read for closed captions.", "refs": { - "BurninDestinationSettings$TeletextSpacing": "Only applies to jobs with input captions in Teletext or STL formats. Specify whether the spacing between letters in your captions is set by the captions grid or varies depending on letter width. Choose fixed grid to conform to the spacing specified in the captions file more accurately. Choose proportional to make the text easier to read if the captions are closed caption." + "BurninDestinationSettings$TeletextSpacing": "Specify whether the text spacing (TeletextSpacing) in your captions is set by the captions grid, or varies depending on letter width. Choose fixed grid (FIXED_GRID) to conform to the spacing specified in the captions file more accurately. Choose proportional (PROPORTIONAL) to make the text easier to read for closed captions." } }, "CancelJobRequest": { @@ -533,9 +533,9 @@ } }, "CaptionSourceFramerate": { - "base": "Ignore this setting unless your input captions format is SCC. To have the service compensate for differing frame rates between your input captions and input video, specify the frame rate of the captions file. Specify this value as a fraction, using the settings Framerate numerator (framerateNumerator) and Framerate denominator (framerateDenominator). For example, you might specify 24 / 1 for 24 fps, 25 / 1 for 25 fps, 24000 / 1001 for 23.976 fps, or 30000 / 1001 for 29.97 fps.", + "base": "Ignore this setting unless your input captions format is SCC. To have the service compensate for differing frame rates between your input captions and input video, specify the frame rate of the captions file. Specify this value as a fraction. When you work directly in your JSON job specification, use the settings framerateNumerator and framerateDenominator. For example, you might specify 24 / 1 for 24 fps, 25 / 1 for 25 fps, 24000 / 1001 for 23.976 fps, or 30000 / 1001 for 29.97 fps.", "refs": { - "FileSourceSettings$Framerate": "Ignore this setting unless your input captions format is SCC. To have the service compensate for differing frame rates between your input captions and input video, specify the frame rate of the captions file. Specify this value as a fraction, using the settings Framerate numerator (framerateNumerator) and Framerate denominator (framerateDenominator). For example, you might specify 24 / 1 for 24 fps, 25 / 1 for 25 fps, 24000 / 1001 for 23.976 fps, or 30000 / 1001 for 29.97 fps." + "FileSourceSettings$Framerate": "Ignore this setting unless your input captions format is SCC. To have the service compensate for differing frame rates between your input captions and input video, specify the frame rate of the captions file. Specify this value as a fraction. When you work directly in your JSON job specification, use the settings framerateNumerator and framerateDenominator. For example, you might specify 24 / 1 for 24 fps, 25 / 1 for 25 fps, 24000 / 1001 for 23.976 fps, or 30000 / 1001 for 29.97 fps." } }, "CaptionSourceSettings": { @@ -1077,57 +1077,57 @@ } }, "DvbSubSubtitleFallbackFont": { - "base": "Specify the font that you want the service to use for your burn in captions when your input captions specify a font that MediaConvert doesn't support. When you keep the default value, Best match (BEST_MATCH), MediaConvert uses a supported font that most closely matches the font that your input captions specify. When there are multiple unsupported fonts in your input captions, MediaConvert matches each font with the supported font that matches best. When you explicitly choose a replacement font, MediaConvert uses that font to replace all unsupported fonts from your input.", + "base": "Specify the font that you want the service to use for your burn in captions when your input captions specify a font that MediaConvert doesn't support. When you set Fallback font (FallbackFont) to best match (BEST_MATCH), or leave blank, MediaConvert uses a supported font that most closely matches the font that your input captions specify. When there are multiple unsupported fonts in your input captions, MediaConvert matches each font with the supported font that matches best. When you explicitly choose a replacement font, MediaConvert uses that font to replace all unsupported fonts from your input.", "refs": { - "DvbSubDestinationSettings$FallbackFont": "Specify the font that you want the service to use for your burn in captions when your input captions specify a font that MediaConvert doesn't support. When you keep the default value, Best match (BEST_MATCH), MediaConvert uses a supported font that most closely matches the font that your input captions specify. When there are multiple unsupported fonts in your input captions, MediaConvert matches each font with the supported font that matches best. When you explicitly choose a replacement font, MediaConvert uses that font to replace all unsupported fonts from your input." + "DvbSubDestinationSettings$FallbackFont": "Specify the font that you want the service to use for your burn in captions when your input captions specify a font that MediaConvert doesn't support. When you set Fallback font (FallbackFont) to best match (BEST_MATCH), or leave blank, MediaConvert uses a supported font that most closely matches the font that your input captions specify. When there are multiple unsupported fonts in your input captions, MediaConvert matches each font with the supported font that matches best. When you explicitly choose a replacement font, MediaConvert uses that font to replace all unsupported fonts from your input." } }, "DvbSubtitleAlignment": { - "base": "If no explicit x_position or y_position is provided, setting alignment to centered will place the captions at the bottom center of the output. Similarly, setting a left alignment will align captions to the bottom left of the output. If x and y positions are given in conjunction with the alignment parameter, the font will be justified (either left or centered) relative to those coordinates. This option is not valid for source captions that are STL, 608/embedded or teletext. These source settings are already pre-defined by the caption stream. All burn-in and DVB-Sub font settings must match.", + "base": "Specify the alignment of your captions. If no explicit x_position is provided, setting alignment to centered will placethe captions at the bottom center of the output. Similarly, setting a left alignment willalign captions to the bottom left of the output. If x and y positions are given in conjunction with the alignment parameter, the font will be justified (either left or centered) relative to those coordinates. Within your job settings, all of your DVB-Sub settings must be identical.", "refs": { - "DvbSubDestinationSettings$Alignment": "If no explicit x_position or y_position is provided, setting alignment to centered will place the captions at the bottom center of the output. Similarly, setting a left alignment will align captions to the bottom left of the output. If x and y positions are given in conjunction with the alignment parameter, the font will be justified (either left or centered) relative to those coordinates. This option is not valid for source captions that are STL, 608/embedded or teletext. These source settings are already pre-defined by the caption stream. All burn-in and DVB-Sub font settings must match." + "DvbSubDestinationSettings$Alignment": "Specify the alignment of your captions. If no explicit x_position is provided, setting alignment to centered will placethe captions at the bottom center of the output. Similarly, setting a left alignment willalign captions to the bottom left of the output. If x and y positions are given in conjunction with the alignment parameter, the font will be justified (either left or centered) relative to those coordinates. Within your job settings, all of your DVB-Sub settings must be identical." } }, "DvbSubtitleApplyFontColor": { - "base": "Ignore this setting unless your input captions are STL, any type of 608, teletext, or TTML, and your output captions are DVB-SUB. Specify how the service applies the color specified in the setting Font color (DvbSubtitleFontColor). By default, this color is white. When you choose WHITE_TEXT_ONLY, the service uses the specified font color only for text that is white in the input. When you choose ALL_TEXT, the service uses the specified font color for all output captions text. If you leave both settings at their default value, your output font color is the same as your input font color.", + "base": "Ignore this setting unless Style Passthrough (StylePassthrough) is set to Enabled and Font color (FontColor) set to Black, Yellow, Red, Green, Blue, or Hex. Use Apply font color (ApplyFontColor) for additional font color controls. When you choose White text only (WHITE_TEXT_ONLY), or leave blank, your font color setting only applies to white text in your input captions. For example, if your font color setting is Yellow, and your input captions have red and white text, your output captions will have red and yellow text. When you choose ALL_TEXT, your font color setting applies to all of your output captions text.", "refs": { - "DvbSubDestinationSettings$ApplyFontColor": "Ignore this setting unless your input captions are STL, any type of 608, teletext, or TTML, and your output captions are DVB-SUB. Specify how the service applies the color specified in the setting Font color (DvbSubtitleFontColor). By default, this color is white. When you choose WHITE_TEXT_ONLY, the service uses the specified font color only for text that is white in the input. When you choose ALL_TEXT, the service uses the specified font color for all output captions text. If you leave both settings at their default value, your output font color is the same as your input font color." + "DvbSubDestinationSettings$ApplyFontColor": "Ignore this setting unless Style Passthrough (StylePassthrough) is set to Enabled and Font color (FontColor) set to Black, Yellow, Red, Green, Blue, or Hex. Use Apply font color (ApplyFontColor) for additional font color controls. When you choose White text only (WHITE_TEXT_ONLY), or leave blank, your font color setting only applies to white text in your input captions. For example, if your font color setting is Yellow, and your input captions have red and white text, your output captions will have red and yellow text. When you choose ALL_TEXT, your font color setting applies to all of your output captions text." } }, "DvbSubtitleBackgroundColor": { - "base": "Specifies the color of the rectangle behind the captions.\nAll burn-in and DVB-Sub font settings must match.", + "base": "Specify the color of the rectangle behind the captions. Leave background color (BackgroundColor) blank and set Style passthrough (StylePassthrough) to enabled to use the background color data from your input captions, if present.", "refs": { - "DvbSubDestinationSettings$BackgroundColor": "Specifies the color of the rectangle behind the captions.\nAll burn-in and DVB-Sub font settings must match." + "DvbSubDestinationSettings$BackgroundColor": "Specify the color of the rectangle behind the captions. Leave background color (BackgroundColor) blank and set Style passthrough (StylePassthrough) to enabled to use the background color data from your input captions, if present." } }, "DvbSubtitleFontColor": { - "base": "Specifies the color of the DVB-SUB captions. This option is not valid for source captions that are STL, 608/embedded or teletext. These source settings are already pre-defined by the caption stream. All burn-in and DVB-Sub font settings must match.", + "base": "Specify the color of the captions text. Leave Font color (FontColor) blank and set Style passthrough (StylePassthrough) to enabled to use the font color data from your input captions, if present. Within your job settings, all of your DVB-Sub settings must be identical.", "refs": { - "DvbSubDestinationSettings$FontColor": "Specifies the color of the DVB-SUB captions. This option is not valid for source captions that are STL, 608/embedded or teletext. These source settings are already pre-defined by the caption stream. All burn-in and DVB-Sub font settings must match." + "DvbSubDestinationSettings$FontColor": "Specify the color of the captions text. Leave Font color (FontColor) blank and set Style passthrough (StylePassthrough) to enabled to use the font color data from your input captions, if present. Within your job settings, all of your DVB-Sub settings must be identical." } }, "DvbSubtitleOutlineColor": { - "base": "Specifies font outline color. This option is not valid for source captions that are either 608/embedded or teletext. These source settings are already pre-defined by the caption stream. All burn-in and DVB-Sub font settings must match.", + "base": "Specify font outline color. Leave Outline color (OutlineColor) blank and set Style passthrough (StylePassthrough) to enabled to use the font outline color data from your input captions, if present. Within your job settings, all of your DVB-Sub settings must be identical.", "refs": { - "DvbSubDestinationSettings$OutlineColor": "Specifies font outline color. This option is not valid for source captions that are either 608/embedded or teletext. These source settings are already pre-defined by the caption stream. All burn-in and DVB-Sub font settings must match." + "DvbSubDestinationSettings$OutlineColor": "Specify font outline color. Leave Outline color (OutlineColor) blank and set Style passthrough (StylePassthrough) to enabled to use the font outline color data from your input captions, if present. Within your job settings, all of your DVB-Sub settings must be identical." } }, "DvbSubtitleShadowColor": { - "base": "Specifies the color of the shadow cast by the captions.\nAll burn-in and DVB-Sub font settings must match.", + "base": "Specify the color of the shadow cast by the captions. Leave Shadow color (ShadowColor) blank and set Style passthrough (StylePassthrough) to enabled to use the shadow color data from your input captions, if present. Within your job settings, all of your DVB-Sub settings must be identical.", "refs": { - "DvbSubDestinationSettings$ShadowColor": "Specifies the color of the shadow cast by the captions.\nAll burn-in and DVB-Sub font settings must match." + "DvbSubDestinationSettings$ShadowColor": "Specify the color of the shadow cast by the captions. Leave Shadow color (ShadowColor) blank and set Style passthrough (StylePassthrough) to enabled to use the shadow color data from your input captions, if present. Within your job settings, all of your DVB-Sub settings must be identical." } }, "DvbSubtitleStylePassthrough": { - "base": "Choose which set of style and position values the service applies to your output captions. When you choose ENABLED, the service uses the input style and position information from your input. When you choose DISABLED, the service uses any style values that you specify in your output settings. If you don't specify values, the service uses default style and position values. When you choose DISABLED, the service ignores all style and position values from your input.", + "base": "Set Style passthrough (StylePassthrough) to ENABLED to use the available style, color, and position information from your input captions. MediaConvert uses default settings for any missing style and position information in your input captions. Set Style passthrough to DISABLED, or leave blank, to ignore the style and position information from your input captions and use default settings: white text with black outlining, bottom-center positioning, and automatic sizing. Whether you set Style passthrough to enabled or not, you can also choose to manually override any of the individual style and position settings.", "refs": { - "DvbSubDestinationSettings$StylePassthrough": "Choose which set of style and position values the service applies to your output captions. When you choose ENABLED, the service uses the input style and position information from your input. When you choose DISABLED, the service uses any style values that you specify in your output settings. If you don't specify values, the service uses default style and position values. When you choose DISABLED, the service ignores all style and position values from your input." + "DvbSubDestinationSettings$StylePassthrough": "Set Style passthrough (StylePassthrough) to ENABLED to use the available style, color, and position information from your input captions. MediaConvert uses default settings for any missing style and position information in your input captions. Set Style passthrough to DISABLED, or leave blank, to ignore the style and position information from your input captions and use default settings: white text with black outlining, bottom-center positioning, and automatic sizing. Whether you set Style passthrough to enabled or not, you can also choose to manually override any of the individual style and position settings." } }, "DvbSubtitleTeletextSpacing": { - "base": "Only applies to jobs with input captions in Teletext or STL formats. Specify whether the spacing between letters in your captions is set by the captions grid or varies depending on letter width. Choose fixed grid to conform to the spacing specified in the captions file more accurately. Choose proportional to make the text easier to read if the captions are closed caption.", + "base": "Specify whether the Text spacing (TextSpacing) in your captions is set by the captions grid, or varies depending on letter width. Choose fixed grid (FIXED_GRID) to conform to the spacing specified in the captions file more accurately. Choose proportional (PROPORTIONAL) to make the text easier to read for closed captions. Within your job settings, all of your DVB-Sub settings must be identical.", "refs": { - "DvbSubDestinationSettings$TeletextSpacing": "Only applies to jobs with input captions in Teletext or STL formats. Specify whether the spacing between letters in your captions is set by the captions grid or varies depending on letter width. Choose fixed grid to conform to the spacing specified in the captions file more accurately. Choose proportional to make the text easier to read if the captions are closed caption." + "DvbSubDestinationSettings$TeletextSpacing": "Specify whether the Text spacing (TextSpacing) in your captions is set by the captions grid, or varies depending on letter width. Choose fixed grid (FIXED_GRID) to conform to the spacing specified in the captions file more accurately. Choose proportional (PROPORTIONAL) to make the text easier to read for closed captions. Within your job settings, all of your DVB-Sub settings must be identical." } }, "DvbSubtitlingType": { @@ -1395,11 +1395,17 @@ "CaptionSourceSettings$FileSourceSettings": "If your input captions are SCC, SMI, SRT, STL, TTML, WebVTT, or IMSC 1.1 in an xml file, specify the URI of the input caption source file. If your caption source is IMSC in an IMF package, use TrackSourceSettings instead of FileSoureSettings." } }, + "FileSourceTimeDeltaUnits": { + "base": "When you use the setting Time delta (TimeDelta) to adjust the sync between your sidecar captions and your video, use this setting to specify the units for the delta that you specify. When you don't specify a value for Time delta units (TimeDeltaUnits), MediaConvert uses seconds by default.", + "refs": { + "FileSourceSettings$TimeDeltaUnits": "When you use the setting Time delta (TimeDelta) to adjust the sync between your sidecar captions and your video, use this setting to specify the units for the delta that you specify. When you don't specify a value for Time delta units (TimeDeltaUnits), MediaConvert uses seconds by default." + } + }, "FontScript": { "base": "Provide the font script, using an ISO 15924 script code, if the LanguageCode is not sufficient for determining the script type. Where LanguageCode or CustomLanguageCode is sufficient, use \"AUTOMATIC\" or leave unset.", "refs": { - "BurninDestinationSettings$FontScript": "Provide the font script, using an ISO 15924 script code, if the LanguageCode is not sufficient for determining the script type. Where LanguageCode or CustomLanguageCode is sufficient, use \"AUTOMATIC\" or leave unset. This is used to help determine the appropriate font for rendering burn-in captions.", - "DvbSubDestinationSettings$FontScript": "Provide the font script, using an ISO 15924 script code, if the LanguageCode is not sufficient for determining the script type. Where LanguageCode or CustomLanguageCode is sufficient, use \"AUTOMATIC\" or leave unset. This is used to help determine the appropriate font for rendering DVB-Sub captions." + "BurninDestinationSettings$FontScript": "Set Font script (FontScript) to Automatically determined (AUTOMATIC), or leave blank, to automatically determine the font script in your input captions. Otherwise, set to Simplified Chinese (HANS) or Traditional Chinese (HANT) if your input font script uses Simplified or Traditional Chinese.", + "DvbSubDestinationSettings$FontScript": "Set Font script (FontScript) to Automatically determined (AUTOMATIC), or leave blank, to automatically determine the font script in your input captions. Otherwise, set to Simplified Chinese (HANS) or Traditional Chinese (HANT) if your input font script uses Simplified or Traditional Chinese. Within your job settings, all of your DVB-Sub settings must be identical." } }, "ForbiddenException": { @@ -2079,9 +2085,9 @@ } }, "InputSampleRange": { - "base": "Use this setting when your input video codec is AVC-Intra. Ignore this setting for all other inputs. If the sample range metadata in your input video is accurate, or if you don't know about sample range, keep the default value, Follow (FOLLOW), for this setting. When you do, the service automatically detects your input sample range. If your input video has metadata indicating the wrong sample range, specify the accurate sample range here. When you do, MediaConvert ignores any sample range information in the input metadata. Regardless of whether MediaConvert uses the input sample range or the sample range that you specify, MediaConvert uses the sample range for transcoding and also writes it to the output metadata.", + "base": "If the sample range metadata in your input video is accurate, or if you don't know about sample range, keep the default value, Follow (FOLLOW), for this setting. When you do, the service automatically detects your input sample range. If your input video has metadata indicating the wrong sample range, specify the accurate sample range here. When you do, MediaConvert ignores any sample range information in the input metadata. Regardless of whether MediaConvert uses the input sample range or the sample range that you specify, MediaConvert uses the sample range for transcoding and also writes it to the output metadata.", "refs": { - "VideoSelector$SampleRange": "Use this setting when your input video codec is AVC-Intra. Ignore this setting for all other inputs. If the sample range metadata in your input video is accurate, or if you don't know about sample range, keep the default value, Follow (FOLLOW), for this setting. When you do, the service automatically detects your input sample range. If your input video has metadata indicating the wrong sample range, specify the accurate sample range here. When you do, MediaConvert ignores any sample range information in the input metadata. Regardless of whether MediaConvert uses the input sample range or the sample range that you specify, MediaConvert uses the sample range for transcoding and also writes it to the output metadata." + "VideoSelector$SampleRange": "If the sample range metadata in your input video is accurate, or if you don't know about sample range, keep the default value, Follow (FOLLOW), for this setting. When you do, the service automatically detects your input sample range. If your input video has metadata indicating the wrong sample range, specify the accurate sample range here. When you do, MediaConvert ignores any sample range information in the input metadata. Regardless of whether MediaConvert uses the input sample range or the sample range that you specify, MediaConvert uses the sample range for transcoding and also writes it to the output metadata." } }, "InputScanType": { @@ -3128,15 +3134,15 @@ } }, "SrtDestinationSettings": { - "base": "SRT Destination Settings", + "base": "Settings related to SRT captions. SRT is a sidecar format that holds captions in a file that is separate from the video container. Set up sidecar captions in the same output group, but different output from your video. When you work directly in your JSON job specification, include this object and any required children when you set destinationType to SRT.", "refs": { - "CaptionDestinationSettings$SrtDestinationSettings": "SRT Destination Settings" + "CaptionDestinationSettings$SrtDestinationSettings": "Settings related to SRT captions. SRT is a sidecar format that holds captions in a file that is separate from the video container. Set up sidecar captions in the same output group, but different output from your video. When you work directly in your JSON job specification, include this object and any required children when you set destinationType to SRT." } }, "SrtStylePassthrough": { - "base": "Choose Enabled (ENABLED) to have MediaConvert use the font style, color, and position information from the captions source in the input. Keep the default value, Disabled (DISABLED), for simplified output captions.", + "base": "Set Style passthrough (StylePassthrough) to ENABLED to use the available style, color, and position information from your input captions. MediaConvert uses default settings for any missing style and position information in your input captions. Set Style passthrough to DISABLED, or leave blank, to ignore the style and position information from your input captions and use simplified output captions.", "refs": { - "SrtDestinationSettings$StylePassthrough": "Choose Enabled (ENABLED) to have MediaConvert use the font style, color, and position information from the captions source in the input. Keep the default value, Disabled (DISABLED), for simplified output captions." + "SrtDestinationSettings$StylePassthrough": "Set Style passthrough (StylePassthrough) to ENABLED to use the available style, color, and position information from your input captions. MediaConvert uses default settings for any missing style and position information in your input captions. Set Style passthrough to DISABLED, or leave blank, to ignore the style and position information from your input captions and use simplified output captions." } }, "StaticKeyProvider": { @@ -3494,9 +3500,9 @@ } }, "WebvttDestinationSettings": { - "base": "WEBVTT Destination Settings", + "base": "Settings related to WebVTT captions. WebVTT is a sidecar format that holds captions in a file that is separate from the video container. Set up sidecar captions in the same output group, but different output from your video. For more information, see https://docs.aws.amazon.com/mediaconvert/latest/ug/ttml-and-webvtt-output-captions.html. When you work directly in your JSON job specification, include this object and any required children when you set destinationType to WebVTT.", "refs": { - "CaptionDestinationSettings$WebvttDestinationSettings": "WEBVTT Destination Settings" + "CaptionDestinationSettings$WebvttDestinationSettings": "Settings related to WebVTT captions. WebVTT is a sidecar format that holds captions in a file that is separate from the video container. Set up sidecar captions in the same output group, but different output from your video. For more information, see https://docs.aws.amazon.com/mediaconvert/latest/ug/ttml-and-webvtt-output-captions.html. When you work directly in your JSON job specification, include this object and any required children when you set destinationType to WebVTT." } }, "WebvttHlsSourceSettings": { @@ -3506,9 +3512,9 @@ } }, "WebvttStylePassthrough": { - "base": "Choose Enabled (ENABLED) to have MediaConvert use the font style, color, and position information from the captions source in the input. Keep the default value, Disabled (DISABLED), for simplified output captions.", + "base": "Set Style passthrough (StylePassthrough) to ENABLED to use the available style, color, and position information from your input captions. MediaConvert uses default settings for any missing style and position information in your input captions. Set Style passthrough to DISABLED, or leave blank, to ignore the style and position information from your input captions and use simplified output captions.", "refs": { - "WebvttDestinationSettings$StylePassthrough": "Choose Enabled (ENABLED) to have MediaConvert use the font style, color, and position information from the captions source in the input. Keep the default value, Disabled (DISABLED), for simplified output captions." + "WebvttDestinationSettings$StylePassthrough": "Set Style passthrough (StylePassthrough) to ENABLED to use the available style, color, and position information from your input captions. MediaConvert uses default settings for any missing style and position information in your input captions. Set Style passthrough to DISABLED, or leave blank, to ignore the style and position information from your input captions and use simplified output captions." } }, "Xavc4kIntraCbgProfileClass": { @@ -3770,8 +3776,8 @@ "__integerMin0Max10": { "base": null, "refs": { - "BurninDestinationSettings$OutlineSize": "Specifies font outline size in pixels. This option is not valid for source captions that are either 608/embedded or teletext. These source settings are already pre-defined by the caption stream. All burn-in and DVB-Sub font settings must match.", - "DvbSubDestinationSettings$OutlineSize": "Specifies font outline size in pixels. This option is not valid for source captions that are either 608/embedded or teletext. These source settings are already pre-defined by the caption stream. All burn-in and DVB-Sub font settings must match." + "BurninDestinationSettings$OutlineSize": "Specify the Outline size (OutlineSize) of the caption text, in pixels. Leave Outline size blank and set Style passthrough (StylePassthrough) to enabled to use the outline size data from your input captions, if present.", + "DvbSubDestinationSettings$OutlineSize": "Specify the Outline size (OutlineSize) of the caption text, in pixels. Leave Outline size blank and set Style passthrough (StylePassthrough) to enabled to use the outline size data from your input captions, if present. Within your job settings, all of your DVB-Sub settings must be identical." } }, "__integerMin0Max100": { @@ -3839,14 +3845,14 @@ "__integerMin0Max2147483647": { "base": null, "refs": { - "BurninDestinationSettings$XPosition": "Specifies the horizontal position of the caption relative to the left side of the output in pixels. A value of 10 would result in the captions starting 10 pixels from the left of the output. If no explicit x_position is provided, the horizontal caption position will be determined by the alignment parameter. This option is not valid for source captions that are STL, 608/embedded or teletext. These source settings are already pre-defined by the caption stream. All burn-in and DVB-Sub font settings must match.", - "BurninDestinationSettings$YPosition": "Specifies the vertical position of the caption relative to the top of the output in pixels. A value of 10 would result in the captions starting 10 pixels from the top of the output. If no explicit y_position is provided, the caption will be positioned towards the bottom of the output. This option is not valid for source captions that are STL, 608/embedded or teletext. These source settings are already pre-defined by the caption stream. All burn-in and DVB-Sub font settings must match.", + "BurninDestinationSettings$XPosition": "Specify the horizontal position (XPosition) of the captions, relative to the left side of the output in pixels. A value of 10 would result in the captions starting 10 pixels from the left of the output. If no explicit x_position is provided, the horizontal caption position will be determined by the alignment parameter.", + "BurninDestinationSettings$YPosition": "Specify the vertical position (YPosition) of the captions, relative to the top of the output in pixels. A value of 10 would result in the captions starting 10 pixels from the top of the output. If no explicit y_position is provided, the caption will be positioned towards the bottom of the output.", "CmafGroupSettings$MinBufferTime": "Minimum time of initially buffered media that is needed to ensure smooth playout.", "DashIsoGroupSettings$MinBufferTime": "Minimum time of initially buffered media that is needed to ensure smooth playout.", "DvbSubDestinationSettings$DdsXCoordinate": "Use this setting, along with DDS y-coordinate (ddsYCoordinate), to specify the upper left corner of the display definition segment (DDS) display window. With this setting, specify the distance, in pixels, between the left side of the frame and the left side of the DDS display window. Keep the default value, 0, to have MediaConvert automatically choose this offset. Related setting: When you use this setting, you must set DDS handling (ddsHandling) to a value other than None (NONE). MediaConvert uses these values to determine whether to write page position data to the DDS or to the page composition segment (PCS). All burn-in and DVB-Sub font settings must match.", "DvbSubDestinationSettings$DdsYCoordinate": "Use this setting, along with DDS x-coordinate (ddsXCoordinate), to specify the upper left corner of the display definition segment (DDS) display window. With this setting, specify the distance, in pixels, between the top of the frame and the top of the DDS display window. Keep the default value, 0, to have MediaConvert automatically choose this offset. Related setting: When you use this setting, you must set DDS handling (ddsHandling) to a value other than None (NONE). MediaConvert uses these values to determine whether to write page position data to the DDS or to the page composition segment (PCS). All burn-in and DVB-Sub font settings must match.", - "DvbSubDestinationSettings$XPosition": "Specifies the horizontal position of the caption relative to the left side of the output in pixels. A value of 10 would result in the captions starting 10 pixels from the left of the output. If no explicit x_position is provided, the horizontal caption position will be determined by the alignment parameter. This option is not valid for source captions that are STL, 608/embedded or teletext. These source settings are already pre-defined by the caption stream. All burn-in and DVB-Sub font settings must match.", - "DvbSubDestinationSettings$YPosition": "Specifies the vertical position of the caption relative to the top of the output in pixels. A value of 10 would result in the captions starting 10 pixels from the top of the output. If no explicit y_position is provided, the caption will be positioned towards the bottom of the output. This option is not valid for source captions that are STL, 608/embedded or teletext. These source settings are already pre-defined by the caption stream. All burn-in and DVB-Sub font settings must match.", + "DvbSubDestinationSettings$XPosition": "Specify the horizontal position (XPosition) of the captions, relative to the left side of the outputin pixels. A value of 10 would result in the captions starting 10 pixels from the left ofthe output. If no explicit x_position is provided, the horizontal caption position will bedetermined by the alignment parameter. Within your job settings, all of your DVB-Sub settings must be identical.", + "DvbSubDestinationSettings$YPosition": "Specify the vertical position (YPosition) of the captions, relative to the top of the output in pixels. A value of 10 would result in the captions starting 10 pixels from the top of the output. If no explicit y_position is provided, the caption will be positioned towards the bottom of the output. Within your job settings, all of your DVB-Sub settings must be identical.", "H264Settings$GopClosedCadence": "Frequency of closed GOPs. In streaming applications, it is recommended that this be set to 1 so a decoder joining mid-stream will receive an IDR frame as quickly as possible. Setting this value to 0 will break output segmenting.", "H265Settings$GopClosedCadence": "Frequency of closed GOPs. In streaming applications, it is recommended that this be set to 1 so a decoder joining mid-stream will receive an IDR frame as quickly as possible. Setting this value to 0 will break output segmenting.", "Hdr10Metadata$MaxLuminance": "Nominal maximum mastering display luminance in units of of 0.0001 candelas per square meter.", @@ -3877,12 +3883,12 @@ "base": null, "refs": { "AudioDescription$AudioType": "Applies only if Follow Input Audio Type is unchecked (false). A number between 0 and 255. The following are defined in ISO-IEC 13818-1: 0 = Undefined, 1 = Clean Effects, 2 = Hearing Impaired, 3 = Visually Impaired Commentary, 4-255 = Reserved.", - "BurninDestinationSettings$BackgroundOpacity": "Specifies the opacity of the background rectangle. 255 is opaque; 0 is transparent. Leaving this parameter blank is equivalent to setting it to 0 (transparent). All burn-in and DVB-Sub font settings must match.", - "BurninDestinationSettings$FontOpacity": "Specifies the opacity of the burned-in captions. 255 is opaque; 0 is transparent.\nAll burn-in and DVB-Sub font settings must match.", - "BurninDestinationSettings$ShadowOpacity": "Specifies the opacity of the shadow. 255 is opaque; 0 is transparent. Leaving this parameter blank is equivalent to setting it to 0 (transparent). All burn-in and DVB-Sub font settings must match.", - "DvbSubDestinationSettings$BackgroundOpacity": "Specifies the opacity of the background rectangle. 255 is opaque; 0 is transparent. Leaving this parameter blank is equivalent to setting it to 0 (transparent). All burn-in and DVB-Sub font settings must match.", - "DvbSubDestinationSettings$FontOpacity": "Specifies the opacity of the burned-in captions. 255 is opaque; 0 is transparent.\nAll burn-in and DVB-Sub font settings must match.", - "DvbSubDestinationSettings$ShadowOpacity": "Specifies the opacity of the shadow. 255 is opaque; 0 is transparent. Leaving this parameter blank is equivalent to setting it to 0 (transparent). All burn-in and DVB-Sub font settings must match." + "BurninDestinationSettings$BackgroundOpacity": "Specify the opacity of the background rectangle. Enter a value from 0 to 255, where 0 is transparent and 255 is opaque. If Style passthrough (StylePassthrough) is set to enabled, leave blank to pass through the background style information in your input captions to your output captions. If Style passthrough is set to disabled, leave blank to use a value of 0 and remove all backgrounds from your output captions.", + "BurninDestinationSettings$FontOpacity": "Specify the opacity of the burned-in captions. 255 is opaque; 0 is transparent.", + "BurninDestinationSettings$ShadowOpacity": "Specify the opacity of the shadow. Enter a value from 0 to 255, where 0 is transparent and 255 is opaque. If Style passthrough (StylePassthrough) is set to Enabled, leave Shadow opacity (ShadowOpacity) blank to pass through the shadow style information in your input captions to your output captions. If Style passthrough is set to disabled, leave blank to use a value of 0 and remove all shadows from your output captions.", + "DvbSubDestinationSettings$BackgroundOpacity": "Specify the opacity of the background rectangle. Enter a value from 0 to 255, where 0 is transparent and 255 is opaque. If Style passthrough (StylePassthrough) is set to enabled, leave blank to pass through the background style information in your input captions to your output captions. If Style passthrough is set to disabled, leave blank to use a value of 0 and remove all backgrounds from your output captions. Within your job settings, all of your DVB-Sub settings must be identical.", + "DvbSubDestinationSettings$FontOpacity": "Specify the opacity of the burned-in captions. 255 is opaque; 0 is transparent.\nWithin your job settings, all of your DVB-Sub settings must be identical.", + "DvbSubDestinationSettings$ShadowOpacity": "Specify the opacity of the shadow. Enter a value from 0 to 255, where 0 is transparent and 255 is opaque. If Style passthrough (StylePassthrough) is set to Enabled, leave Shadow opacity (ShadowOpacity) blank to pass through the shadow style information in your input captions to your output captions. If Style passthrough is set to disabled, leave blank to use a value of 0 and remove all shadows from your output captions. Within your job settings, all of your DVB-Sub settings must be identical." } }, "__integerMin0Max3": { @@ -4002,8 +4008,8 @@ "__integerMin0Max96": { "base": null, "refs": { - "BurninDestinationSettings$FontSize": "A positive integer indicates the exact font size in points. Set to 0 for automatic font size selection. All burn-in and DVB-Sub font settings must match.", - "DvbSubDestinationSettings$FontSize": "A positive integer indicates the exact font size in points. Set to 0 for automatic font size selection. All burn-in and DVB-Sub font settings must match." + "BurninDestinationSettings$FontSize": "Specify the Font size (FontSize) in pixels. Must be a positive integer. Set to 0, or leave blank, for automatic font size.", + "DvbSubDestinationSettings$FontSize": "Specify the Font size (FontSize) in pixels. Must be a positive integer. Set to 0, or leave blank, for automatic font size. Within your job settings, all of your DVB-Sub settings must be identical." } }, "__integerMin0Max99": { @@ -4427,8 +4433,8 @@ "__integerMin96Max600": { "base": null, "refs": { - "BurninDestinationSettings$FontResolution": "Font resolution in DPI (dots per inch); default is 96 dpi.\nAll burn-in and DVB-Sub font settings must match.", - "DvbSubDestinationSettings$FontResolution": "Font resolution in DPI (dots per inch); default is 96 dpi.\nAll burn-in and DVB-Sub font settings must match." + "BurninDestinationSettings$FontResolution": "Specify the Font resolution (FontResolution) in DPI (dots per inch).", + "DvbSubDestinationSettings$FontResolution": "Specify the Font resolution (FontResolution) in DPI (dots per inch).\nWithin your job settings, all of your DVB-Sub settings must be identical." } }, "__integerMinNegative1000Max1000": { @@ -4460,11 +4466,11 @@ "base": null, "refs": { "AudioSelector$Offset": "Specifies a time delta in milliseconds to offset the audio from the input video.", - "BurninDestinationSettings$ShadowXOffset": "Specifies the horizontal offset of the shadow relative to the captions in pixels. A value of -2 would result in a shadow offset 2 pixels to the left. All burn-in and DVB-Sub font settings must match.", - "BurninDestinationSettings$ShadowYOffset": "Specifies the vertical offset of the shadow relative to the captions in pixels. A value of -2 would result in a shadow offset 2 pixels above the text. All burn-in and DVB-Sub font settings must match.", - "DvbSubDestinationSettings$ShadowXOffset": "Specifies the horizontal offset of the shadow relative to the captions in pixels. A value of -2 would result in a shadow offset 2 pixels to the left. All burn-in and DVB-Sub font settings must match.", - "DvbSubDestinationSettings$ShadowYOffset": "Specifies the vertical offset of the shadow relative to the captions in pixels. A value of -2 would result in a shadow offset 2 pixels above the text. All burn-in and DVB-Sub font settings must match.", - "FileSourceSettings$TimeDelta": "Specifies a time delta in seconds to offset the captions from the source file.", + "BurninDestinationSettings$ShadowXOffset": "Specify the horizontal offset of the shadow, relative to the captions in pixels. A value of -2 would result in a shadow offset 2 pixels to the left.", + "BurninDestinationSettings$ShadowYOffset": "Specify the vertical offset of the shadow relative to the captions in pixels. A value of -2 would result in a shadow offset 2 pixels above the text. Leave Shadow y-offset (ShadowYOffset) blank and set Style passthrough (StylePassthrough) to enabled to use the shadow y-offset data from your input captions, if present.", + "DvbSubDestinationSettings$ShadowXOffset": "Specify the horizontal offset of the shadow, relative to the captions in pixels. A value of -2 would result in a shadow offset 2 pixels to the left. Within your job settings, all of your DVB-Sub settings must be identical.", + "DvbSubDestinationSettings$ShadowYOffset": "Specify the vertical offset of the shadow relative to the captions in pixels. A value of -2 would result in a shadow offset 2 pixels above the text. Leave Shadow y-offset (ShadowYOffset) blank and set Style passthrough (StylePassthrough) to enabled to use the shadow y-offset data from your input captions, if present. Within your job settings, all of your DVB-Sub settings must be identical.", + "FileSourceSettings$TimeDelta": "Optional. Use this setting when you need to adjust the sync between your sidecar captions and your video. For more information, see https://docs.aws.amazon.com/mediaconvert/latest/ug/time-delta-use-cases.html. Enter a positive or negative number to modify the times in the captions file. For example, type 15 to add 15 seconds to all the times in the captions file. Type -5 to subtract 5 seconds from the times in the captions file. You can optionally specify your time delta in milliseconds instead of seconds. When you do so, set the related setting, Time delta units (TimeDeltaUnits) to Milliseconds (MILLISECONDS). Note that, when you specify a time delta for timecode-based caption sources, such as SCC and STL, and your time delta isn't a multiple of the input frame rate, MediaConvert snaps the captions to the nearest frame. For example, when your input video frame rate is 25 fps and you specify 1010ms for time delta, MediaConvert delays your captions by 1000 ms.", "HlsCaptionLanguageMapping$CaptionChannel": "Caption channel.", "HlsGroupSettings$TimedMetadataId3Period": "Timed Metadata interval in seconds.", "HlsGroupSettings$TimestampDeltaMilliseconds": "Provides an extra millisecond delta offset to fine tune the timestamps.", @@ -5016,8 +5022,8 @@ "__stringMin6Max8Pattern09aFAF609aFAF2": { "base": null, "refs": { - "BurninDestinationSettings$HexFontColor": "Ignore this setting unless your BurninSubtitleFontColor setting is HEX. Format is six or eight hexidecimal digits, representing the red, green, and blue components, with the two extra digits used for an optional alpha value. For example a value of 1122AABB is a red value of 0x11, a green value of 0x22, a blue value of 0xAA, and an alpha value of 0xBB.", - "DvbSubDestinationSettings$HexFontColor": "Ignore this setting unless your DvbSubtitleFontColor setting is HEX. Format is six or eight hexidecimal digits, representing the red, green, and blue components, with the two extra digits used for an optional alpha value. For example a value of 1122AABB is a red value of 0x11, a green value of 0x22, a blue value of 0xAA, and an alpha value of 0xBB." + "BurninDestinationSettings$HexFontColor": "Ignore this setting unless your Font color is set to Hex. Enter either six or eight hexidecimal digits, representing red, green, and blue, with two optional extra digits for alpha. For example a value of 1122AABB is a red value of 0x11, a green value of 0x22, a blue value of 0xAA, and an alpha value of 0xBB.", + "DvbSubDestinationSettings$HexFontColor": "Ignore this setting unless your Font color is set to Hex. Enter either six or eight hexidecimal digits, representing red, green, and blue, with two optional extra digits for alpha. For example a value of 1122AABB is a red value of 0x11, a green value of 0x22, a blue value of 0xAA, and an alpha value of 0xBB." } }, "__stringMin9Max19PatternAZ26EastWestCentralNorthSouthEastWest1912": { @@ -5200,4 +5206,4 @@ } } } -} +} \ No newline at end of file diff --git a/models/apis/mediapackage-vod/2018-11-07/api-2.json b/models/apis/mediapackage-vod/2018-11-07/api-2.json index 74962223cf..baec9a7e45 100644 --- a/models/apis/mediapackage-vod/2018-11-07/api-2.json +++ b/models/apis/mediapackage-vod/2018-11-07/api-2.json @@ -1349,6 +1349,10 @@ "locationName": "hlsManifests", "shape": "__listOfHlsManifest" }, + "IncludeDvbSubtitles": { + "locationName": "includeDvbSubtitles", + "shape": "__boolean" + }, "SegmentDurationSeconds": { "locationName": "segmentDurationSeconds", "shape": "__integer" diff --git a/models/apis/mediapackage-vod/2018-11-07/docs-2.json b/models/apis/mediapackage-vod/2018-11-07/docs-2.json index f65189c4ed..29fef62766 100644 --- a/models/apis/mediapackage-vod/2018-11-07/docs-2.json +++ b/models/apis/mediapackage-vod/2018-11-07/docs-2.json @@ -249,6 +249,7 @@ "DashPackage$IncludeEncoderConfigurationInSegments" : "When includeEncoderConfigurationInSegments is set to true, MediaPackage places your encoder's Sequence Parameter Set (SPS), Picture Parameter Set (PPS), and Video Parameter Set (VPS) metadata in every video segment instead of in the init fragment. This lets you use different SPS/PPS/VPS settings for your assets during content playback.\n", "HlsManifest$IncludeIframeOnlyStream" : "When enabled, an I-Frame only stream will be included in the output.", "HlsManifest$RepeatExtXKey" : "When enabled, the EXT-X-KEY tag will be repeated in output manifests.", + "HlsPackage$IncludeDvbSubtitles" : "When enabled, MediaPackage passes through digital video broadcasting (DVB) subtitles into the output.", "HlsPackage$UseAudioRenditionGroup" : "When enabled, audio streams will be placed in rendition groups in the output." } }, diff --git a/models/apis/mediapackage/2017-10-12/api-2.json b/models/apis/mediapackage/2017-10-12/api-2.json index 4a3ee59bc5..d54c0f7ed9 100644 --- a/models/apis/mediapackage/2017-10-12/api-2.json +++ b/models/apis/mediapackage/2017-10-12/api-2.json @@ -1680,6 +1680,10 @@ "locationName": "encryption", "shape": "HlsEncryption" }, + "IncludeDvbSubtitles": { + "locationName": "includeDvbSubtitles", + "shape": "__boolean" + }, "IncludeIframeOnlyStream": { "locationName": "includeIframeOnlyStream", "shape": "__boolean" diff --git a/models/apis/mediapackage/2017-10-12/docs-2.json b/models/apis/mediapackage/2017-10-12/docs-2.json index 16bb5610ce..866fc660b7 100644 --- a/models/apis/mediapackage/2017-10-12/docs-2.json +++ b/models/apis/mediapackage/2017-10-12/docs-2.json @@ -342,6 +342,7 @@ "HlsEncryption$RepeatExtXKey" : "When enabled, the EXT-X-KEY tag will be repeated in output manifests.", "HlsManifest$IncludeIframeOnlyStream" : "When enabled, an I-Frame only stream will be included in the output.", "HlsManifestCreateOrUpdateParameters$IncludeIframeOnlyStream" : "When enabled, an I-Frame only stream will be included in the output.", + "HlsPackage$IncludeDvbSubtitles" : "When enabled, MediaPackage passes through digital video broadcasting (DVB) subtitles into the output.", "HlsPackage$IncludeIframeOnlyStream" : "When enabled, an I-Frame only stream will be included in the output.", "HlsPackage$UseAudioRenditionGroup" : "When enabled, audio streams will be placed in rendition groups in the output." } diff --git a/models/apis/panorama/2019-07-24/api-2.json b/models/apis/panorama/2019-07-24/api-2.json new file mode 100644 index 0000000000..c0d61b7917 --- /dev/null +++ b/models/apis/panorama/2019-07-24/api-2.json @@ -0,0 +1,2436 @@ +{ + "version":"2.0", + "metadata":{ + "apiVersion":"2019-07-24", + "endpointPrefix":"panorama", + "jsonVersion":"1.1", + "protocol":"rest-json", + "serviceAbbreviation":"Panorama", + "serviceFullName":"AWS Panorama", + "serviceId":"Panorama", + "signatureVersion":"v4", + "signingName":"panorama", + "uid":"panorama-2019-07-24" + }, + "operations":{ + "CreateApplicationInstance":{ + "name":"CreateApplicationInstance", + "http":{ + "method":"POST", + "requestUri":"/application-instances" + }, + "input":{"shape":"CreateApplicationInstanceRequest"}, + "output":{"shape":"CreateApplicationInstanceResponse"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"InternalServerException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ServiceQuotaExceededException"} + ] + }, + "CreateJobForDevices":{ + "name":"CreateJobForDevices", + "http":{ + "method":"POST", + "requestUri":"/jobs" + }, + "input":{"shape":"CreateJobForDevicesRequest"}, + "output":{"shape":"CreateJobForDevicesResponse"}, + "errors":[ + {"shape":"ConflictException"}, + {"shape":"ValidationException"}, + {"shape":"InternalServerException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ResourceNotFoundException"} + ] + }, + "CreateNodeFromTemplateJob":{ + "name":"CreateNodeFromTemplateJob", + "http":{ + "method":"POST", + "requestUri":"/packages/template-job" + }, + "input":{"shape":"CreateNodeFromTemplateJobRequest"}, + "output":{"shape":"CreateNodeFromTemplateJobResponse"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"InternalServerException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ConflictException"} + ] + }, + "CreatePackage":{ + "name":"CreatePackage", + "http":{ + "method":"POST", + "requestUri":"/packages" + }, + "input":{"shape":"CreatePackageRequest"}, + "output":{"shape":"CreatePackageResponse"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"InternalServerException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ConflictException"} + ] + }, + "CreatePackageImportJob":{ + "name":"CreatePackageImportJob", + "http":{ + "method":"POST", + "requestUri":"/packages/import-jobs" + }, + "input":{"shape":"CreatePackageImportJobRequest"}, + "output":{"shape":"CreatePackageImportJobResponse"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"InternalServerException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ConflictException"} + ] + }, + "DeleteDevice":{ + "name":"DeleteDevice", + "http":{ + "method":"DELETE", + "requestUri":"/devices/{DeviceId}" + }, + "input":{"shape":"DeleteDeviceRequest"}, + "output":{"shape":"DeleteDeviceResponse"}, + "errors":[ + {"shape":"ConflictException"}, + {"shape":"ValidationException"}, + {"shape":"InternalServerException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ResourceNotFoundException"} + ] + }, + "DeletePackage":{ + "name":"DeletePackage", + "http":{ + "method":"DELETE", + "requestUri":"/packages/{PackageId}" + }, + "input":{"shape":"DeletePackageRequest"}, + "output":{"shape":"DeletePackageResponse"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"InternalServerException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ConflictException"}, + {"shape":"ResourceNotFoundException"} + ] + }, + "DeregisterPackageVersion":{ + "name":"DeregisterPackageVersion", + "http":{ + "method":"DELETE", + "requestUri":"/packages/{PackageId}/versions/{PackageVersion}/patch/{PatchVersion}" + }, + "input":{"shape":"DeregisterPackageVersionRequest"}, + "output":{"shape":"DeregisterPackageVersionResponse"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"InternalServerException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ConflictException"}, + {"shape":"ResourceNotFoundException"} + ] + }, + "DescribeApplicationInstance":{ + "name":"DescribeApplicationInstance", + "http":{ + "method":"GET", + "requestUri":"/application-instances/{applicationInstanceId}" + }, + "input":{"shape":"DescribeApplicationInstanceRequest"}, + "output":{"shape":"DescribeApplicationInstanceResponse"}, + "errors":[ + {"shape":"ConflictException"}, + {"shape":"ValidationException"}, + {"shape":"InternalServerException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ResourceNotFoundException"} + ] + }, + "DescribeApplicationInstanceDetails":{ + "name":"DescribeApplicationInstanceDetails", + "http":{ + "method":"GET", + "requestUri":"/application-instances/{applicationInstanceId}/details" + }, + "input":{"shape":"DescribeApplicationInstanceDetailsRequest"}, + "output":{"shape":"DescribeApplicationInstanceDetailsResponse"}, + "errors":[ + {"shape":"ConflictException"}, + {"shape":"ValidationException"}, + {"shape":"InternalServerException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ResourceNotFoundException"} + ] + }, + "DescribeDevice":{ + "name":"DescribeDevice", + "http":{ + "method":"GET", + "requestUri":"/devices/{DeviceId}" + }, + "input":{"shape":"DescribeDeviceRequest"}, + "output":{"shape":"DescribeDeviceResponse"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"InternalServerException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ResourceNotFoundException"} + ] + }, + "DescribeDeviceJob":{ + "name":"DescribeDeviceJob", + "http":{ + "method":"GET", + "requestUri":"/jobs/{JobId}" + }, + "input":{"shape":"DescribeDeviceJobRequest"}, + "output":{"shape":"DescribeDeviceJobResponse"}, + "errors":[ + {"shape":"ConflictException"}, + {"shape":"ValidationException"}, + {"shape":"InternalServerException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ResourceNotFoundException"} + ] + }, + "DescribeNode":{ + "name":"DescribeNode", + "http":{ + "method":"GET", + "requestUri":"/nodes/{NodeId}" + }, + "input":{"shape":"DescribeNodeRequest"}, + "output":{"shape":"DescribeNodeResponse"}, + "errors":[ + {"shape":"ConflictException"}, + {"shape":"ValidationException"}, + {"shape":"InternalServerException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ResourceNotFoundException"} + ] + }, + "DescribeNodeFromTemplateJob":{ + "name":"DescribeNodeFromTemplateJob", + "http":{ + "method":"GET", + "requestUri":"/packages/template-job/{JobId}" + }, + "input":{"shape":"DescribeNodeFromTemplateJobRequest"}, + "output":{"shape":"DescribeNodeFromTemplateJobResponse"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"InternalServerException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ConflictException"} + ] + }, + "DescribePackage":{ + "name":"DescribePackage", + "http":{ + "method":"GET", + "requestUri":"/packages/metadata/{PackageId}" + }, + "input":{"shape":"DescribePackageRequest"}, + "output":{"shape":"DescribePackageResponse"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"InternalServerException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ConflictException"}, + {"shape":"ResourceNotFoundException"} + ] + }, + "DescribePackageImportJob":{ + "name":"DescribePackageImportJob", + "http":{ + "method":"GET", + "requestUri":"/packages/import-jobs/{JobId}" + }, + "input":{"shape":"DescribePackageImportJobRequest"}, + "output":{"shape":"DescribePackageImportJobResponse"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"InternalServerException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ConflictException"} + ] + }, + "DescribePackageVersion":{ + "name":"DescribePackageVersion", + "http":{ + "method":"GET", + "requestUri":"/packages/metadata/{PackageId}/versions/{PackageVersion}" + }, + "input":{"shape":"DescribePackageVersionRequest"}, + "output":{"shape":"DescribePackageVersionResponse"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"InternalServerException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ConflictException"}, + {"shape":"ResourceNotFoundException"} + ] + }, + "ListApplicationInstanceDependencies":{ + "name":"ListApplicationInstanceDependencies", + "http":{ + "method":"GET", + "requestUri":"/application-instances/{applicationInstanceId}/package-dependencies" + }, + "input":{"shape":"ListApplicationInstanceDependenciesRequest"}, + "output":{"shape":"ListApplicationInstanceDependenciesResponse"}, + "errors":[ + {"shape":"AccessDeniedException"}, + {"shape":"InternalServerException"} + ] + }, + "ListApplicationInstanceNodeInstances":{ + "name":"ListApplicationInstanceNodeInstances", + "http":{ + "method":"GET", + "requestUri":"/application-instances/{applicationInstanceId}/node-instances" + }, + "input":{"shape":"ListApplicationInstanceNodeInstancesRequest"}, + "output":{"shape":"ListApplicationInstanceNodeInstancesResponse"}, + "errors":[ + {"shape":"AccessDeniedException"}, + {"shape":"InternalServerException"} + ] + }, + "ListApplicationInstances":{ + "name":"ListApplicationInstances", + "http":{ + "method":"GET", + "requestUri":"/application-instances" + }, + "input":{"shape":"ListApplicationInstancesRequest"}, + "output":{"shape":"ListApplicationInstancesResponse"}, + "errors":[ + {"shape":"AccessDeniedException"}, + {"shape":"InternalServerException"} + ] + }, + "ListDevices":{ + "name":"ListDevices", + "http":{ + "method":"GET", + "requestUri":"/devices" + }, + "input":{"shape":"ListDevicesRequest"}, + "output":{"shape":"ListDevicesResponse"}, + "errors":[ + {"shape":"ConflictException"}, + {"shape":"ValidationException"}, + {"shape":"InternalServerException"}, + {"shape":"AccessDeniedException"} + ] + }, + "ListDevicesJobs":{ + "name":"ListDevicesJobs", + "http":{ + "method":"GET", + "requestUri":"/jobs" + }, + "input":{"shape":"ListDevicesJobsRequest"}, + "output":{"shape":"ListDevicesJobsResponse"}, + "errors":[ + {"shape":"ConflictException"}, + {"shape":"ValidationException"}, + {"shape":"InternalServerException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ResourceNotFoundException"} + ] + }, + "ListNodeFromTemplateJobs":{ + "name":"ListNodeFromTemplateJobs", + "http":{ + "method":"GET", + "requestUri":"/packages/template-job" + }, + "input":{"shape":"ListNodeFromTemplateJobsRequest"}, + "output":{"shape":"ListNodeFromTemplateJobsResponse"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"InternalServerException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ConflictException"} + ] + }, + "ListNodes":{ + "name":"ListNodes", + "http":{ + "method":"GET", + "requestUri":"/nodes" + }, + "input":{"shape":"ListNodesRequest"}, + "output":{"shape":"ListNodesResponse"}, + "errors":[ + {"shape":"ConflictException"}, + {"shape":"ValidationException"}, + {"shape":"InternalServerException"} + ] + }, + "ListPackageImportJobs":{ + "name":"ListPackageImportJobs", + "http":{ + "method":"GET", + "requestUri":"/packages/import-jobs" + }, + "input":{"shape":"ListPackageImportJobsRequest"}, + "output":{"shape":"ListPackageImportJobsResponse"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"InternalServerException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ConflictException"} + ] + }, + "ListPackages":{ + "name":"ListPackages", + "http":{ + "method":"GET", + "requestUri":"/packages" + }, + "input":{"shape":"ListPackagesRequest"}, + "output":{"shape":"ListPackagesResponse"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"InternalServerException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ConflictException"}, + {"shape":"ResourceNotFoundException"} + ] + }, + "ListTagsForResource":{ + "name":"ListTagsForResource", + "http":{ + "method":"GET", + "requestUri":"/tags/{ResourceArn}" + }, + "input":{"shape":"ListTagsForResourceRequest"}, + "output":{"shape":"ListTagsForResourceResponse"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"ValidationException"}, + {"shape":"InternalServerException"} + ] + }, + "ProvisionDevice":{ + "name":"ProvisionDevice", + "http":{ + "method":"POST", + "requestUri":"/devices" + }, + "input":{"shape":"ProvisionDeviceRequest"}, + "output":{"shape":"ProvisionDeviceResponse"}, + "errors":[ + {"shape":"ConflictException"}, + {"shape":"ValidationException"}, + {"shape":"InternalServerException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ServiceQuotaExceededException"} + ] + }, + "RegisterPackageVersion":{ + "name":"RegisterPackageVersion", + "http":{ + "method":"PUT", + "requestUri":"/packages/{PackageId}/versions/{PackageVersion}/patch/{PatchVersion}" + }, + "input":{"shape":"RegisterPackageVersionRequest"}, + "output":{"shape":"RegisterPackageVersionResponse"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"InternalServerException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ConflictException"} + ] + }, + "RemoveApplicationInstance":{ + "name":"RemoveApplicationInstance", + "http":{ + "method":"DELETE", + "requestUri":"/application-instances/{applicationInstanceId}" + }, + "input":{"shape":"RemoveApplicationInstanceRequest"}, + "output":{"shape":"RemoveApplicationInstanceResponse"}, + "errors":[ + {"shape":"ConflictException"}, + {"shape":"ValidationException"}, + {"shape":"InternalServerException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ResourceNotFoundException"} + ] + }, + "TagResource":{ + "name":"TagResource", + "http":{ + "method":"POST", + "requestUri":"/tags/{ResourceArn}" + }, + "input":{"shape":"TagResourceRequest"}, + "output":{"shape":"TagResourceResponse"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"ValidationException"}, + {"shape":"InternalServerException"} + ] + }, + "UntagResource":{ + "name":"UntagResource", + "http":{ + "method":"DELETE", + "requestUri":"/tags/{ResourceArn}" + }, + "input":{"shape":"UntagResourceRequest"}, + "output":{"shape":"UntagResourceResponse"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"ValidationException"}, + {"shape":"InternalServerException"} + ] + }, + "UpdateDeviceMetadata":{ + "name":"UpdateDeviceMetadata", + "http":{ + "method":"PUT", + "requestUri":"/devices/{DeviceId}" + }, + "input":{"shape":"UpdateDeviceMetadataRequest"}, + "output":{"shape":"UpdateDeviceMetadataResponse"}, + "errors":[ + {"shape":"ConflictException"}, + {"shape":"ValidationException"}, + {"shape":"InternalServerException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ResourceNotFoundException"} + ] + } + }, + "shapes":{ + "AccessDeniedException":{ + "type":"structure", + "required":["Message"], + "members":{ + "Message":{"shape":"String"} + }, + "error":{"httpStatusCode":403}, + "exception":true + }, + "ApplicationInstance":{ + "type":"structure", + "members":{ + "Name":{"shape":"ApplicationInstanceName"}, + "ApplicationInstanceId":{"shape":"ApplicationInstanceId"}, + "DefaultRuntimeContextDevice":{"shape":"DefaultRuntimeContextDevice"}, + "DefaultRuntimeContextDeviceName":{"shape":"DeviceName"}, + "Description":{"shape":"Description"}, + "Status":{"shape":"ApplicationInstanceStatus"}, + "HealthStatus":{"shape":"ApplicationInstanceHealthStatus"}, + "StatusDescription":{"shape":"ApplicationInstanceStatusDescription"}, + "CreatedTime":{"shape":"TimeStamp"}, + "Arn":{"shape":"ApplicationInstanceArn"}, + "Tags":{"shape":"TagMap"} + } + }, + "ApplicationInstanceArn":{ + "type":"string", + "max":255, + "min":1 + }, + "ApplicationInstanceHealthStatus":{ + "type":"string", + "enum":[ + "RUNNING", + "ERROR", + "NOT_AVAILABLE" + ] + }, + "ApplicationInstanceId":{ + "type":"string", + "max":255, + "min":1, + "pattern":"^[a-zA-Z0-9\\-\\_]+$" + }, + "ApplicationInstanceName":{ + "type":"string", + "max":255, + "min":1, + "pattern":"^[a-zA-Z0-9\\-\\_]+$" + }, + "ApplicationInstanceStatus":{ + "type":"string", + "enum":[ + "DEPLOYMENT_PENDING", + "DEPLOYMENT_REQUESTED", + "DEPLOYMENT_IN_PROGRESS", + "DEPLOYMENT_ERROR", + "DEPLOYMENT_SUCCEEDED", + "REMOVAL_PENDING", + "REMOVAL_REQUESTED", + "REMOVAL_IN_PROGRESS", + "REMOVAL_FAILED", + "REMOVAL_SUCCEEDED" + ] + }, + "ApplicationInstanceStatusDescription":{ + "type":"string", + "max":255, + "min":1 + }, + "ApplicationInstances":{ + "type":"list", + "member":{"shape":"ApplicationInstance"} + }, + "Boolean":{"type":"boolean"}, + "Bucket":{"type":"string"}, + "BucketName":{ + "type":"string", + "max":255, + "min":1, + "pattern":"^.+$" + }, + "Certificates":{"type":"blob"}, + "ClientToken":{ + "type":"string", + "max":64, + "min":1, + "pattern":"^[a-zA-Z0-9\\-\\_]+$" + }, + "ConflictException":{ + "type":"structure", + "required":[ + "Message", + "ResourceId", + "ResourceType" + ], + "members":{ + "Message":{"shape":"String"}, + "ResourceId":{"shape":"String"}, + "ResourceType":{"shape":"String"}, + "ErrorId":{"shape":"String"}, + "ErrorArguments":{"shape":"ConflictExceptionErrorArgumentList"} + }, + "error":{"httpStatusCode":409}, + "exception":true + }, + "ConflictExceptionErrorArgument":{ + "type":"structure", + "required":[ + "Name", + "Value" + ], + "members":{ + "Name":{"shape":"String"}, + "Value":{"shape":"String"} + } + }, + "ConflictExceptionErrorArgumentList":{ + "type":"list", + "member":{"shape":"ConflictExceptionErrorArgument"} + }, + "ConnectionType":{ + "type":"string", + "enum":[ + "STATIC_IP", + "DHCP" + ] + }, + "CreateApplicationInstanceRequest":{ + "type":"structure", + "required":[ + "ManifestPayload", + "DefaultRuntimeContextDevice" + ], + "members":{ + "Name":{"shape":"ApplicationInstanceName"}, + "Description":{"shape":"Description"}, + "ManifestPayload":{"shape":"ManifestPayload"}, + "ManifestOverridesPayload":{"shape":"ManifestOverridesPayload"}, + "ApplicationInstanceIdToReplace":{"shape":"ApplicationInstanceId"}, + "RuntimeRoleArn":{"shape":"RuntimeRoleArn"}, + "DefaultRuntimeContextDevice":{"shape":"DefaultRuntimeContextDevice"}, + "Tags":{"shape":"TagMap"} + } + }, + "CreateApplicationInstanceResponse":{ + "type":"structure", + "required":["ApplicationInstanceId"], + "members":{ + "ApplicationInstanceId":{"shape":"ApplicationInstanceId"} + } + }, + "CreateJobForDevicesRequest":{ + "type":"structure", + "required":[ + "DeviceIds", + "DeviceJobConfig", + "JobType" + ], + "members":{ + "DeviceIds":{"shape":"DeviceIdList"}, + "DeviceJobConfig":{"shape":"DeviceJobConfig"}, + "JobType":{"shape":"JobType"} + } + }, + "CreateJobForDevicesResponse":{ + "type":"structure", + "required":["Jobs"], + "members":{ + "Jobs":{"shape":"JobList"} + } + }, + "CreateNodeFromTemplateJobRequest":{ + "type":"structure", + "required":[ + "TemplateType", + "OutputPackageName", + "OutputPackageVersion", + "NodeName", + "TemplateParameters" + ], + "members":{ + "TemplateType":{"shape":"TemplateType"}, + "OutputPackageName":{"shape":"NodePackageName"}, + "OutputPackageVersion":{"shape":"NodePackageVersion"}, + "NodeName":{"shape":"NodeName"}, + "NodeDescription":{"shape":"Description"}, + "TemplateParameters":{"shape":"TemplateParametersMap"}, + "JobTags":{"shape":"JobTagsList"} + } + }, + "CreateNodeFromTemplateJobResponse":{ + "type":"structure", + "required":["JobId"], + "members":{ + "JobId":{"shape":"JobId"} + } + }, + "CreatePackageImportJobRequest":{ + "type":"structure", + "required":[ + "JobType", + "InputConfig", + "OutputConfig", + "ClientToken" + ], + "members":{ + "JobType":{"shape":"PackageImportJobType"}, + "InputConfig":{"shape":"PackageImportJobInputConfig"}, + "OutputConfig":{"shape":"PackageImportJobOutputConfig"}, + "ClientToken":{"shape":"ClientToken"}, + "JobTags":{"shape":"JobTagsList"} + } + }, + "CreatePackageImportJobResponse":{ + "type":"structure", + "required":["JobId"], + "members":{ + "JobId":{"shape":"JobId"} + } + }, + "CreatePackageRequest":{ + "type":"structure", + "required":["PackageName"], + "members":{ + "PackageName":{"shape":"NodePackageName"}, + "Tags":{"shape":"TagMap"} + } + }, + "CreatePackageResponse":{ + "type":"structure", + "required":["StorageLocation"], + "members":{ + "PackageId":{"shape":"NodePackageId"}, + "Arn":{"shape":"NodePackageArn"}, + "StorageLocation":{"shape":"StorageLocation"} + } + }, + "CreatedTime":{"type":"timestamp"}, + "CurrentSoftware":{ + "type":"string", + "max":255, + "min":1 + }, + "DefaultGateway":{ + "type":"string", + "max":255, + "min":1, + "pattern":"^.+$" + }, + "DefaultRuntimeContextDevice":{ + "type":"string", + "max":255, + "min":1, + "pattern":"^[a-zA-Z0-9\\-\\_]+$" + }, + "DeleteDeviceRequest":{ + "type":"structure", + "required":["DeviceId"], + "members":{ + "DeviceId":{ + "shape":"DeviceId", + "location":"uri", + "locationName":"DeviceId" + } + } + }, + "DeleteDeviceResponse":{ + "type":"structure", + "members":{ + "DeviceId":{"shape":"DeviceId"} + } + }, + "DeletePackageRequest":{ + "type":"structure", + "required":["PackageId"], + "members":{ + "PackageId":{ + "shape":"NodePackageId", + "location":"uri", + "locationName":"PackageId" + }, + "ForceDelete":{ + "shape":"Boolean", + "location":"querystring", + "locationName":"ForceDelete" + } + } + }, + "DeletePackageResponse":{ + "type":"structure", + "members":{ + } + }, + "DeregisterPackageVersionRequest":{ + "type":"structure", + "required":[ + "PackageId", + "PackageVersion", + "PatchVersion" + ], + "members":{ + "OwnerAccount":{ + "shape":"PackageOwnerAccount", + "location":"querystring", + "locationName":"OwnerAccount" + }, + "PackageId":{ + "shape":"NodePackageId", + "location":"uri", + "locationName":"PackageId" + }, + "PackageVersion":{ + "shape":"NodePackageVersion", + "location":"uri", + "locationName":"PackageVersion" + }, + "PatchVersion":{ + "shape":"NodePackagePatchVersion", + "location":"uri", + "locationName":"PatchVersion" + }, + "UpdatedLatestPatchVersion":{ + "shape":"NodePackagePatchVersion", + "location":"querystring", + "locationName":"UpdatedLatestPatchVersion" + } + } + }, + "DeregisterPackageVersionResponse":{ + "type":"structure", + "members":{ + } + }, + "DescribeApplicationInstanceDetailsRequest":{ + "type":"structure", + "required":["ApplicationInstanceId"], + "members":{ + "ApplicationInstanceId":{ + "shape":"ApplicationInstanceId", + "location":"uri", + "locationName":"applicationInstanceId" + } + } + }, + "DescribeApplicationInstanceDetailsResponse":{ + "type":"structure", + "members":{ + "Name":{"shape":"ApplicationInstanceName"}, + "Description":{"shape":"Description"}, + "DefaultRuntimeContextDevice":{"shape":"DefaultRuntimeContextDevice"}, + "ManifestPayload":{"shape":"ManifestPayload"}, + "ManifestOverridesPayload":{"shape":"ManifestOverridesPayload"}, + "ApplicationInstanceIdToReplace":{"shape":"ApplicationInstanceId"}, + "CreatedTime":{"shape":"TimeStamp"}, + "ApplicationInstanceId":{"shape":"ApplicationInstanceId"} + } + }, + "DescribeApplicationInstanceRequest":{ + "type":"structure", + "required":["ApplicationInstanceId"], + "members":{ + "ApplicationInstanceId":{ + "shape":"ApplicationInstanceId", + "location":"uri", + "locationName":"applicationInstanceId" + } + } + }, + "DescribeApplicationInstanceResponse":{ + "type":"structure", + "members":{ + "Name":{"shape":"ApplicationInstanceName"}, + "Description":{"shape":"Description"}, + "DefaultRuntimeContextDevice":{"shape":"DefaultRuntimeContextDevice"}, + "DefaultRuntimeContextDeviceName":{"shape":"DeviceName"}, + "ApplicationInstanceIdToReplace":{"shape":"ApplicationInstanceId"}, + "RuntimeRoleArn":{"shape":"RuntimeRoleArn"}, + "Status":{"shape":"ApplicationInstanceStatus"}, + "HealthStatus":{"shape":"ApplicationInstanceHealthStatus"}, + "StatusDescription":{"shape":"ApplicationInstanceStatusDescription"}, + "CreatedTime":{"shape":"TimeStamp"}, + "LastUpdatedTime":{"shape":"TimeStamp"}, + "ApplicationInstanceId":{"shape":"ApplicationInstanceId"}, + "Arn":{"shape":"ApplicationInstanceArn"}, + "Tags":{"shape":"TagMap"} + } + }, + "DescribeDeviceJobRequest":{ + "type":"structure", + "required":["JobId"], + "members":{ + "JobId":{ + "shape":"JobId", + "location":"uri", + "locationName":"JobId" + } + } + }, + "DescribeDeviceJobResponse":{ + "type":"structure", + "members":{ + "JobId":{"shape":"JobId"}, + "DeviceId":{"shape":"DeviceId"}, + "DeviceArn":{"shape":"DeviceArn"}, + "DeviceName":{"shape":"DeviceName"}, + "DeviceType":{"shape":"DeviceType"}, + "ImageVersion":{"shape":"ImageVersion"}, + "Status":{"shape":"UpdateProgress"}, + "CreatedTime":{"shape":"UpdateCreatedTime"} + } + }, + "DescribeDeviceRequest":{ + "type":"structure", + "required":["DeviceId"], + "members":{ + "DeviceId":{ + "shape":"DeviceId", + "location":"uri", + "locationName":"DeviceId" + } + } + }, + "DescribeDeviceResponse":{ + "type":"structure", + "members":{ + "DeviceId":{"shape":"DeviceId"}, + "Name":{"shape":"DeviceName"}, + "Arn":{"shape":"DeviceArn"}, + "Description":{"shape":"Description"}, + "Type":{"shape":"DeviceType"}, + "DeviceConnectionStatus":{"shape":"DeviceConnectionStatus"}, + "CreatedTime":{"shape":"CreatedTime"}, + "ProvisioningStatus":{"shape":"DeviceStatus"}, + "LatestSoftware":{"shape":"LatestSoftware"}, + "CurrentSoftware":{"shape":"CurrentSoftware"}, + "SerialNumber":{"shape":"DeviceSerialNumber"}, + "Tags":{"shape":"TagMap"}, + "NetworkingConfiguration":{"shape":"NetworkPayload"}, + "CurrentNetworkingStatus":{"shape":"NetworkStatus"}, + "LeaseExpirationTime":{"shape":"LeaseExpirationTime"} + } + }, + "DescribeNodeFromTemplateJobRequest":{ + "type":"structure", + "required":["JobId"], + "members":{ + "JobId":{ + "shape":"JobId", + "location":"uri", + "locationName":"JobId" + } + } + }, + "DescribeNodeFromTemplateJobResponse":{ + "type":"structure", + "required":[ + "JobId", + "Status", + "StatusMessage", + "CreatedTime", + "LastUpdatedTime", + "OutputPackageName", + "OutputPackageVersion", + "NodeName", + "TemplateType", + "TemplateParameters" + ], + "members":{ + "JobId":{"shape":"JobId"}, + "Status":{"shape":"NodeFromTemplateJobStatus"}, + "StatusMessage":{"shape":"NodeFromTemplateJobStatusMessage"}, + "CreatedTime":{"shape":"CreatedTime"}, + "LastUpdatedTime":{"shape":"LastUpdatedTime"}, + "OutputPackageName":{"shape":"NodePackageName"}, + "OutputPackageVersion":{"shape":"NodePackageVersion"}, + "NodeName":{"shape":"NodeName"}, + "NodeDescription":{"shape":"Description"}, + "TemplateType":{"shape":"TemplateType"}, + "TemplateParameters":{"shape":"TemplateParametersMap"}, + "JobTags":{"shape":"JobTagsList"} + } + }, + "DescribeNodeRequest":{ + "type":"structure", + "required":["NodeId"], + "members":{ + "NodeId":{ + "shape":"NodeId", + "location":"uri", + "locationName":"NodeId" + }, + "OwnerAccount":{ + "shape":"PackageOwnerAccount", + "location":"querystring", + "locationName":"OwnerAccount" + } + } + }, + "DescribeNodeResponse":{ + "type":"structure", + "required":[ + "NodeId", + "Name", + "Category", + "OwnerAccount", + "PackageName", + "PackageId", + "PackageVersion", + "PatchVersion", + "NodeInterface", + "Description", + "CreatedTime", + "LastUpdatedTime" + ], + "members":{ + "NodeId":{"shape":"NodeId"}, + "Name":{"shape":"NodeName"}, + "Category":{"shape":"NodeCategory"}, + "OwnerAccount":{"shape":"PackageOwnerAccount"}, + "PackageName":{"shape":"NodePackageName"}, + "PackageId":{"shape":"NodePackageId"}, + "PackageArn":{"shape":"NodePackageArn"}, + "PackageVersion":{"shape":"NodePackageVersion"}, + "PatchVersion":{"shape":"NodePackagePatchVersion"}, + "NodeInterface":{"shape":"NodeInterface"}, + "AssetName":{"shape":"NodeAssetName"}, + "Description":{"shape":"Description"}, + "CreatedTime":{"shape":"TimeStamp"}, + "LastUpdatedTime":{"shape":"TimeStamp"} + } + }, + "DescribePackageImportJobRequest":{ + "type":"structure", + "required":["JobId"], + "members":{ + "JobId":{ + "shape":"JobId", + "location":"uri", + "locationName":"JobId" + } + } + }, + "DescribePackageImportJobResponse":{ + "type":"structure", + "required":[ + "JobId", + "JobType", + "InputConfig", + "OutputConfig", + "Output", + "CreatedTime", + "LastUpdatedTime", + "Status", + "StatusMessage" + ], + "members":{ + "JobId":{"shape":"JobId"}, + "ClientToken":{"shape":"ClientToken"}, + "JobType":{"shape":"PackageImportJobType"}, + "InputConfig":{"shape":"PackageImportJobInputConfig"}, + "OutputConfig":{"shape":"PackageImportJobOutputConfig"}, + "Output":{"shape":"PackageImportJobOutput"}, + "CreatedTime":{"shape":"CreatedTime"}, + "LastUpdatedTime":{"shape":"LastUpdatedTime"}, + "Status":{"shape":"PackageImportJobStatus"}, + "StatusMessage":{"shape":"PackageImportJobStatusMessage"}, + "JobTags":{"shape":"JobTagsList"} + } + }, + "DescribePackageRequest":{ + "type":"structure", + "required":["PackageId"], + "members":{ + "PackageId":{ + "shape":"NodePackageId", + "location":"uri", + "locationName":"PackageId" + } + } + }, + "DescribePackageResponse":{ + "type":"structure", + "required":[ + "PackageId", + "PackageName", + "Arn", + "StorageLocation", + "CreatedTime", + "Tags" + ], + "members":{ + "PackageId":{"shape":"NodePackageId"}, + "PackageName":{"shape":"NodePackageName"}, + "Arn":{"shape":"NodePackageArn"}, + "StorageLocation":{"shape":"StorageLocation"}, + "ReadAccessPrincipalArns":{"shape":"PrincipalArnsList"}, + "WriteAccessPrincipalArns":{"shape":"PrincipalArnsList"}, + "CreatedTime":{"shape":"TimeStamp"}, + "Tags":{"shape":"TagMap"} + } + }, + "DescribePackageVersionRequest":{ + "type":"structure", + "required":[ + "PackageId", + "PackageVersion" + ], + "members":{ + "OwnerAccount":{ + "shape":"PackageOwnerAccount", + "location":"querystring", + "locationName":"OwnerAccount" + }, + "PackageId":{ + "shape":"NodePackageId", + "location":"uri", + "locationName":"PackageId" + }, + "PackageVersion":{ + "shape":"NodePackageVersion", + "location":"uri", + "locationName":"PackageVersion" + }, + "PatchVersion":{ + "shape":"NodePackagePatchVersion", + "location":"querystring", + "locationName":"PatchVersion" + } + } + }, + "DescribePackageVersionResponse":{ + "type":"structure", + "required":[ + "PackageId", + "PackageName", + "PackageVersion", + "PatchVersion", + "IsLatestPatch", + "Status" + ], + "members":{ + "OwnerAccount":{"shape":"PackageOwnerAccount"}, + "PackageId":{"shape":"NodePackageId"}, + "PackageArn":{"shape":"NodePackageArn"}, + "PackageName":{"shape":"NodePackageName"}, + "PackageVersion":{"shape":"NodePackageVersion"}, + "PatchVersion":{"shape":"NodePackagePatchVersion"}, + "IsLatestPatch":{"shape":"Boolean"}, + "Status":{"shape":"PackageVersionStatus"}, + "StatusDescription":{"shape":"PackageVersionStatusDescription"}, + "RegisteredTime":{"shape":"TimeStamp"} + } + }, + "Description":{ + "type":"string", + "max":255, + "min":0, + "pattern":"^.*$" + }, + "Device":{ + "type":"structure", + "members":{ + "DeviceId":{"shape":"DeviceId"}, + "Name":{"shape":"DeviceName"}, + "CreatedTime":{"shape":"CreatedTime"}, + "ProvisioningStatus":{"shape":"DeviceStatus"}, + "LastUpdatedTime":{"shape":"LastUpdatedTime"}, + "LeaseExpirationTime":{"shape":"LeaseExpirationTime"} + } + }, + "DeviceArn":{ + "type":"string", + "max":255, + "min":1 + }, + "DeviceConnectionStatus":{ + "type":"string", + "enum":[ + "ONLINE", + "OFFLINE", + "AWAITING_CREDENTIALS", + "NOT_AVAILABLE", + "ERROR" + ] + }, + "DeviceId":{ + "type":"string", + "max":255, + "min":1, + "pattern":"^[a-zA-Z0-9\\-\\_]+$" + }, + "DeviceIdList":{ + "type":"list", + "member":{"shape":"DeviceId"}, + "max":1, + "min":1 + }, + "DeviceJob":{ + "type":"structure", + "members":{ + "DeviceName":{"shape":"DeviceName"}, + "DeviceId":{"shape":"DeviceId"}, + "JobId":{"shape":"JobId"}, + "CreatedTime":{"shape":"CreatedTime"} + } + }, + "DeviceJobConfig":{ + "type":"structure", + "members":{ + "OTAJobConfig":{"shape":"OTAJobConfig"} + } + }, + "DeviceJobList":{ + "type":"list", + "member":{"shape":"DeviceJob"} + }, + "DeviceList":{ + "type":"list", + "member":{"shape":"Device"} + }, + "DeviceName":{ + "type":"string", + "max":255, + "min":1, + "pattern":"^[a-zA-Z0-9\\-\\_]+$" + }, + "DeviceSerialNumber":{ + "type":"string", + "pattern":"^[0-9]{1,20}$" + }, + "DeviceStatus":{ + "type":"string", + "enum":[ + "AWAITING_PROVISIONING", + "PENDING", + "SUCCEEDED", + "FAILED", + "ERROR", + "DELETING" + ] + }, + "DeviceType":{ + "type":"string", + "enum":[ + "PANORAMA_APPLIANCE_DEVELOPER_KIT", + "PANORAMA_APPLIANCE" + ] + }, + "Dns":{ + "type":"string", + "max":255, + "min":1, + "pattern":"^.+$" + }, + "DnsList":{ + "type":"list", + "member":{"shape":"Dns"} + }, + "EthernetPayload":{ + "type":"structure", + "required":["ConnectionType"], + "members":{ + "ConnectionType":{"shape":"ConnectionType"}, + "StaticIpConnectionInfo":{"shape":"StaticIpConnectionInfo"} + } + }, + "EthernetStatus":{ + "type":"structure", + "members":{ + "IpAddress":{"shape":"IpAddress"}, + "ConnectionStatus":{"shape":"NetworkConnectionStatus"}, + "HwAddress":{"shape":"HwAddress"} + } + }, + "HwAddress":{ + "type":"string", + "max":255, + "min":1 + }, + "ImageVersion":{ + "type":"string", + "max":255, + "min":1, + "pattern":"^.+$" + }, + "InputPortList":{ + "type":"list", + "member":{"shape":"NodeInputPort"} + }, + "InternalServerException":{ + "type":"structure", + "required":["Message"], + "members":{ + "Message":{"shape":"String"}, + "RetryAfterSeconds":{ + "shape":"RetryAfterSeconds", + "location":"header", + "locationName":"Retry-After" + } + }, + "error":{"httpStatusCode":500}, + "exception":true, + "fault":true + }, + "IotThingName":{ + "type":"string", + "max":255, + "min":1 + }, + "IpAddress":{ + "type":"string", + "max":255, + "min":1, + "pattern":"^((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d))(:(6553[0-5]|655[0-2]\\d|65[0-4]\\d{2}|6[0-4]\\d{3}|[1-5]\\d{4}|[1-9]\\d{0,3}))?$" + }, + "Job":{ + "type":"structure", + "members":{ + "JobId":{"shape":"JobId"}, + "DeviceId":{"shape":"DeviceId"} + } + }, + "JobId":{ + "type":"string", + "max":255, + "min":1, + "pattern":"^[a-zA-Z0-9\\-\\_]+$" + }, + "JobList":{ + "type":"list", + "member":{"shape":"Job"} + }, + "JobResourceTags":{ + "type":"structure", + "required":[ + "ResourceType", + "Tags" + ], + "members":{ + "ResourceType":{"shape":"JobResourceType"}, + "Tags":{"shape":"TagMap"} + } + }, + "JobResourceType":{ + "type":"string", + "enum":["PACKAGE"] + }, + "JobTagsList":{ + "type":"list", + "member":{"shape":"JobResourceTags"} + }, + "JobType":{ + "type":"string", + "enum":["OTA"] + }, + "LastUpdatedTime":{"type":"timestamp"}, + "LatestSoftware":{ + "type":"string", + "max":255, + "min":1 + }, + "LeaseExpirationTime":{"type":"timestamp"}, + "ListApplicationInstanceDependenciesRequest":{ + "type":"structure", + "required":["ApplicationInstanceId"], + "members":{ + "ApplicationInstanceId":{ + "shape":"ApplicationInstanceId", + "location":"uri", + "locationName":"applicationInstanceId" + }, + "MaxResults":{ + "shape":"MaxSize25", + "location":"querystring", + "locationName":"maxResults" + }, + "NextToken":{ + "shape":"NextToken", + "location":"querystring", + "locationName":"nextToken" + } + } + }, + "ListApplicationInstanceDependenciesResponse":{ + "type":"structure", + "members":{ + "PackageObjects":{"shape":"PackageObjects"}, + "NextToken":{"shape":"NextToken"} + } + }, + "ListApplicationInstanceNodeInstancesRequest":{ + "type":"structure", + "required":["ApplicationInstanceId"], + "members":{ + "ApplicationInstanceId":{ + "shape":"ApplicationInstanceId", + "location":"uri", + "locationName":"applicationInstanceId" + }, + "MaxResults":{ + "shape":"MaxSize25", + "location":"querystring", + "locationName":"maxResults" + }, + "NextToken":{ + "shape":"NextToken", + "location":"querystring", + "locationName":"nextToken" + } + } + }, + "ListApplicationInstanceNodeInstancesResponse":{ + "type":"structure", + "members":{ + "NodeInstances":{"shape":"NodeInstances"}, + "NextToken":{"shape":"NextToken"} + } + }, + "ListApplicationInstancesRequest":{ + "type":"structure", + "members":{ + "DeviceId":{ + "shape":"DeviceId", + "location":"querystring", + "locationName":"deviceId" + }, + "StatusFilter":{ + "shape":"StatusFilter", + "location":"querystring", + "locationName":"statusFilter" + }, + "MaxResults":{ + "shape":"MaxSize25", + "location":"querystring", + "locationName":"maxResults" + }, + "NextToken":{ + "shape":"NextToken", + "location":"querystring", + "locationName":"nextToken" + } + } + }, + "ListApplicationInstancesResponse":{ + "type":"structure", + "members":{ + "ApplicationInstances":{"shape":"ApplicationInstances"}, + "NextToken":{"shape":"NextToken"} + } + }, + "ListDevicesJobsRequest":{ + "type":"structure", + "members":{ + "DeviceId":{ + "shape":"DeviceId", + "location":"querystring", + "locationName":"DeviceId" + }, + "NextToken":{ + "shape":"NextToken", + "location":"querystring", + "locationName":"NextToken" + }, + "MaxResults":{ + "shape":"MaxSize25", + "location":"querystring", + "locationName":"MaxResults" + } + } + }, + "ListDevicesJobsResponse":{ + "type":"structure", + "members":{ + "DeviceJobs":{"shape":"DeviceJobList"}, + "NextToken":{"shape":"NextToken"} + } + }, + "ListDevicesRequest":{ + "type":"structure", + "members":{ + "NextToken":{ + "shape":"NextToken", + "location":"querystring", + "locationName":"NextToken" + }, + "MaxResults":{ + "shape":"MaxSize25", + "location":"querystring", + "locationName":"MaxResults" + } + } + }, + "ListDevicesResponse":{ + "type":"structure", + "required":["Devices"], + "members":{ + "Devices":{"shape":"DeviceList"}, + "NextToken":{"shape":"NextToken"} + } + }, + "ListNodeFromTemplateJobsRequest":{ + "type":"structure", + "members":{ + "NextToken":{ + "shape":"NextToken", + "location":"querystring", + "locationName":"NextToken" + }, + "MaxResults":{ + "shape":"MaxSize25", + "location":"querystring", + "locationName":"MaxResults" + } + } + }, + "ListNodeFromTemplateJobsResponse":{ + "type":"structure", + "required":["NodeFromTemplateJobs"], + "members":{ + "NodeFromTemplateJobs":{"shape":"NodeFromTemplateJobList"}, + "NextToken":{"shape":"NextToken"} + } + }, + "ListNodesRequest":{ + "type":"structure", + "members":{ + "Category":{ + "shape":"NodeCategory", + "location":"querystring", + "locationName":"category" + }, + "OwnerAccount":{ + "shape":"PackageOwnerAccount", + "location":"querystring", + "locationName":"ownerAccount" + }, + "PackageName":{ + "shape":"NodePackageName", + "location":"querystring", + "locationName":"packageName" + }, + "PackageVersion":{ + "shape":"NodePackageVersion", + "location":"querystring", + "locationName":"packageVersion" + }, + "PatchVersion":{ + "shape":"NodePackagePatchVersion", + "location":"querystring", + "locationName":"patchVersion" + }, + "NextToken":{ + "shape":"Token", + "location":"querystring", + "locationName":"nextToken" + }, + "MaxResults":{ + "shape":"MaxSize25", + "location":"querystring", + "locationName":"maxResults" + } + } + }, + "ListNodesResponse":{ + "type":"structure", + "members":{ + "Nodes":{"shape":"NodesList"}, + "NextToken":{"shape":"Token"} + } + }, + "ListPackageImportJobsRequest":{ + "type":"structure", + "members":{ + "NextToken":{ + "shape":"NextToken", + "location":"querystring", + "locationName":"NextToken" + }, + "MaxResults":{ + "shape":"MaxSize25", + "location":"querystring", + "locationName":"MaxResults" + } + } + }, + "ListPackageImportJobsResponse":{ + "type":"structure", + "required":["PackageImportJobs"], + "members":{ + "PackageImportJobs":{"shape":"PackageImportJobList"}, + "NextToken":{"shape":"NextToken"} + } + }, + "ListPackagesRequest":{ + "type":"structure", + "members":{ + "MaxResults":{ + "shape":"MaxSize25", + "location":"querystring", + "locationName":"maxResults" + }, + "NextToken":{ + "shape":"Token", + "location":"querystring", + "locationName":"nextToken" + } + } + }, + "ListPackagesResponse":{ + "type":"structure", + "members":{ + "Packages":{"shape":"PackageList"}, + "NextToken":{"shape":"NextToken"} + } + }, + "ListTagsForResourceRequest":{ + "type":"structure", + "required":["ResourceArn"], + "members":{ + "ResourceArn":{ + "shape":"ResourceArn", + "location":"uri", + "locationName":"ResourceArn" + } + } + }, + "ListTagsForResourceResponse":{ + "type":"structure", + "members":{ + "Tags":{"shape":"TagMap"} + } + }, + "ManifestOverridesPayload":{ + "type":"structure", + "members":{ + "PayloadData":{"shape":"ManifestOverridesPayloadData"} + }, + "union":true + }, + "ManifestOverridesPayloadData":{ + "type":"string", + "max":51200, + "min":0, + "pattern":"^.*$" + }, + "ManifestPayload":{ + "type":"structure", + "members":{ + "PayloadData":{"shape":"ManifestPayloadData"} + }, + "union":true + }, + "ManifestPayloadData":{ + "type":"string", + "max":51200, + "min":1, + "pattern":"^.+$" + }, + "MarkLatestPatch":{"type":"boolean"}, + "Mask":{ + "type":"string", + "max":255, + "min":1, + "pattern":"^.+$" + }, + "MaxConnections":{"type":"integer"}, + "MaxSize25":{ + "type":"integer", + "max":25, + "min":0 + }, + "NetworkConnectionStatus":{ + "type":"string", + "enum":[ + "CONNECTED", + "NOT_CONNECTED" + ] + }, + "NetworkPayload":{ + "type":"structure", + "members":{ + "Ethernet0":{"shape":"EthernetPayload"}, + "Ethernet1":{"shape":"EthernetPayload"} + } + }, + "NetworkStatus":{ + "type":"structure", + "members":{ + "Ethernet0Status":{"shape":"EthernetStatus"}, + "Ethernet1Status":{"shape":"EthernetStatus"} + } + }, + "NextToken":{ + "type":"string", + "max":4096, + "min":1, + "pattern":"^.+$" + }, + "Node":{ + "type":"structure", + "required":[ + "NodeId", + "Name", + "Category", + "PackageName", + "PackageId", + "PackageVersion", + "PatchVersion", + "CreatedTime" + ], + "members":{ + "NodeId":{"shape":"NodeId"}, + "Name":{"shape":"NodeName"}, + "Category":{"shape":"NodeCategory"}, + "OwnerAccount":{"shape":"PackageOwnerAccount"}, + "PackageName":{"shape":"NodePackageName"}, + "PackageId":{"shape":"NodePackageId"}, + "PackageArn":{"shape":"NodePackageArn"}, + "PackageVersion":{"shape":"NodePackageVersion"}, + "PatchVersion":{"shape":"NodePackagePatchVersion"}, + "Description":{"shape":"Description"}, + "CreatedTime":{"shape":"TimeStamp"} + } + }, + "NodeAssetName":{ + "type":"string", + "max":255, + "min":1, + "pattern":"^[a-zA-Z0-9\\-\\_]+$" + }, + "NodeCategory":{ + "type":"string", + "enum":[ + "BUSINESS_LOGIC", + "ML_MODEL", + "MEDIA_SOURCE", + "MEDIA_SINK" + ] + }, + "NodeFromTemplateJob":{ + "type":"structure", + "members":{ + "JobId":{"shape":"JobId"}, + "TemplateType":{"shape":"TemplateType"}, + "Status":{"shape":"NodeFromTemplateJobStatus"}, + "StatusMessage":{"shape":"NodeFromTemplateJobStatusMessage"}, + "CreatedTime":{"shape":"CreatedTime"}, + "NodeName":{"shape":"NodeName"} + } + }, + "NodeFromTemplateJobList":{ + "type":"list", + "member":{"shape":"NodeFromTemplateJob"} + }, + "NodeFromTemplateJobStatus":{ + "type":"string", + "enum":[ + "PENDING", + "SUCCEEDED", + "FAILED" + ] + }, + "NodeFromTemplateJobStatusMessage":{"type":"string"}, + "NodeId":{ + "type":"string", + "max":255, + "min":1, + "pattern":"^[a-zA-Z0-9\\-\\_\\.]+$" + }, + "NodeInputPort":{ + "type":"structure", + "members":{ + "Name":{"shape":"PortName"}, + "Description":{"shape":"Description"}, + "Type":{"shape":"PortType"}, + "DefaultValue":{"shape":"PortDefaultValue"}, + "MaxConnections":{"shape":"MaxConnections"} + } + }, + "NodeInstance":{ + "type":"structure", + "required":[ + "NodeInstanceId", + "CurrentStatus" + ], + "members":{ + "NodeInstanceId":{"shape":"NodeInstanceId"}, + "NodeId":{"shape":"NodeId"}, + "PackageName":{"shape":"NodePackageName"}, + "PackageVersion":{"shape":"NodePackageVersion"}, + "PackagePatchVersion":{"shape":"NodePackagePatchVersion"}, + "NodeName":{"shape":"NodeName"}, + "CurrentStatus":{"shape":"NodeInstanceStatus"} + } + }, + "NodeInstanceId":{ + "type":"string", + "max":128, + "min":1, + "pattern":"^[a-zA-Z0-9\\-\\_]+$" + }, + "NodeInstanceStatus":{ + "type":"string", + "enum":[ + "RUNNING", + "ERROR", + "NOT_AVAILABLE" + ] + }, + "NodeInstances":{ + "type":"list", + "member":{"shape":"NodeInstance"} + }, + "NodeInterface":{ + "type":"structure", + "required":[ + "Inputs", + "Outputs" + ], + "members":{ + "Inputs":{"shape":"InputPortList"}, + "Outputs":{"shape":"OutputPortList"} + } + }, + "NodeName":{ + "type":"string", + "max":128, + "min":1, + "pattern":"^[a-zA-Z0-9\\-\\_]+$" + }, + "NodeOutputPort":{ + "type":"structure", + "members":{ + "Name":{"shape":"PortName"}, + "Description":{"shape":"Description"}, + "Type":{"shape":"PortType"} + } + }, + "NodePackageArn":{ + "type":"string", + "max":255, + "min":1 + }, + "NodePackageId":{ + "type":"string", + "max":255, + "min":1, + "pattern":"^[a-zA-Z0-9\\-\\_\\/]+$" + }, + "NodePackageName":{ + "type":"string", + "max":128, + "min":1, + "pattern":"^[a-zA-Z0-9\\-\\_]+$" + }, + "NodePackagePatchVersion":{ + "type":"string", + "max":255, + "min":1, + "pattern":"^[a-z0-9]+$" + }, + "NodePackageVersion":{ + "type":"string", + "max":255, + "min":1, + "pattern":"^([0-9]+)\\.([0-9]+)$" + }, + "NodesList":{ + "type":"list", + "member":{"shape":"Node"} + }, + "OTAJobConfig":{ + "type":"structure", + "required":["ImageVersion"], + "members":{ + "ImageVersion":{"shape":"ImageVersion"} + } + }, + "Object":{"type":"string"}, + "ObjectKey":{ + "type":"string", + "max":255, + "min":1, + "pattern":"^.+$" + }, + "OutPutS3Location":{ + "type":"structure", + "required":[ + "BucketName", + "ObjectKey" + ], + "members":{ + "BucketName":{"shape":"BucketName"}, + "ObjectKey":{"shape":"ObjectKey"} + } + }, + "OutputPortList":{ + "type":"list", + "member":{"shape":"NodeOutputPort"} + }, + "PackageImportJob":{ + "type":"structure", + "members":{ + "JobId":{"shape":"JobId"}, + "JobType":{"shape":"PackageImportJobType"}, + "Status":{"shape":"PackageImportJobStatus"}, + "StatusMessage":{"shape":"PackageImportJobStatusMessage"}, + "CreatedTime":{"shape":"CreatedTime"}, + "LastUpdatedTime":{"shape":"LastUpdatedTime"} + } + }, + "PackageImportJobInputConfig":{ + "type":"structure", + "members":{ + "PackageVersionInputConfig":{"shape":"PackageVersionInputConfig"} + } + }, + "PackageImportJobList":{ + "type":"list", + "member":{"shape":"PackageImportJob"} + }, + "PackageImportJobOutput":{ + "type":"structure", + "required":[ + "PackageId", + "PackageVersion", + "PatchVersion", + "OutputS3Location" + ], + "members":{ + "PackageId":{"shape":"NodePackageId"}, + "PackageVersion":{"shape":"NodePackageVersion"}, + "PatchVersion":{"shape":"NodePackagePatchVersion"}, + "OutputS3Location":{"shape":"OutPutS3Location"} + } + }, + "PackageImportJobOutputConfig":{ + "type":"structure", + "members":{ + "PackageVersionOutputConfig":{"shape":"PackageVersionOutputConfig"} + } + }, + "PackageImportJobStatus":{ + "type":"string", + "enum":[ + "PENDING", + "SUCCEEDED", + "FAILED" + ] + }, + "PackageImportJobStatusMessage":{"type":"string"}, + "PackageImportJobType":{ + "type":"string", + "enum":["NODE_PACKAGE_VERSION"] + }, + "PackageList":{ + "type":"list", + "member":{"shape":"PackageListItem"} + }, + "PackageListItem":{ + "type":"structure", + "members":{ + "PackageId":{"shape":"NodePackageId"}, + "PackageName":{"shape":"NodePackageName"}, + "Arn":{"shape":"NodePackageArn"}, + "CreatedTime":{"shape":"TimeStamp"}, + "Tags":{"shape":"TagMap"} + } + }, + "PackageObject":{ + "type":"structure", + "required":[ + "Name", + "PackageVersion", + "PatchVersion" + ], + "members":{ + "Name":{"shape":"NodePackageName"}, + "PackageVersion":{"shape":"NodePackageVersion"}, + "PatchVersion":{"shape":"NodePackagePatchVersion"} + } + }, + "PackageObjects":{ + "type":"list", + "member":{"shape":"PackageObject"} + }, + "PackageOwnerAccount":{ + "type":"string", + "max":12, + "min":1, + "pattern":"^[0-9a-z\\_]+$" + }, + "PackageVersionInputConfig":{ + "type":"structure", + "required":["S3Location"], + "members":{ + "S3Location":{"shape":"S3Location"} + } + }, + "PackageVersionOutputConfig":{ + "type":"structure", + "required":[ + "PackageName", + "PackageVersion" + ], + "members":{ + "PackageName":{"shape":"NodePackageName"}, + "PackageVersion":{"shape":"NodePackageVersion"}, + "MarkLatest":{"shape":"MarkLatestPatch"} + } + }, + "PackageVersionStatus":{ + "type":"string", + "enum":[ + "REGISTER_PENDING", + "REGISTER_COMPLETED", + "FAILED", + "DELETING" + ] + }, + "PackageVersionStatusDescription":{ + "type":"string", + "max":255, + "min":1 + }, + "PortDefaultValue":{ + "type":"string", + "max":255, + "min":1 + }, + "PortName":{ + "type":"string", + "max":50, + "min":1, + "pattern":"^[a-zA-Z0-9\\_]+$" + }, + "PortType":{ + "type":"string", + "enum":[ + "BOOLEAN", + "STRING", + "INT32", + "FLOAT32", + "MEDIA" + ] + }, + "PrincipalArn":{ + "type":"string", + "max":255, + "min":1, + "pattern":"^arn:[a-z0-9][-.a-z0-9]{0,62}:iam::[0-9]{12}:[a-zA-Z0-9+=,.@\\-_/]+$" + }, + "PrincipalArnsList":{ + "type":"list", + "member":{"shape":"PrincipalArn"} + }, + "ProvisionDeviceRequest":{ + "type":"structure", + "required":["Name"], + "members":{ + "Name":{"shape":"DeviceName"}, + "Description":{"shape":"Description"}, + "Tags":{"shape":"TagMap"}, + "NetworkingConfiguration":{"shape":"NetworkPayload"} + } + }, + "ProvisionDeviceResponse":{ + "type":"structure", + "required":[ + "Arn", + "Status" + ], + "members":{ + "DeviceId":{"shape":"DeviceId"}, + "Arn":{"shape":"DeviceArn"}, + "Status":{"shape":"DeviceStatus"}, + "Certificates":{"shape":"Certificates"}, + "IotThingName":{"shape":"IotThingName"} + } + }, + "Region":{ + "type":"string", + "max":255, + "min":1, + "pattern":"^.+$" + }, + "RegisterPackageVersionRequest":{ + "type":"structure", + "required":[ + "PackageId", + "PackageVersion", + "PatchVersion" + ], + "members":{ + "OwnerAccount":{"shape":"PackageOwnerAccount"}, + "PackageId":{ + "shape":"NodePackageId", + "location":"uri", + "locationName":"PackageId" + }, + "PackageVersion":{ + "shape":"NodePackageVersion", + "location":"uri", + "locationName":"PackageVersion" + }, + "PatchVersion":{ + "shape":"NodePackagePatchVersion", + "location":"uri", + "locationName":"PatchVersion" + }, + "MarkLatest":{"shape":"MarkLatestPatch"} + } + }, + "RegisterPackageVersionResponse":{ + "type":"structure", + "members":{ + } + }, + "RemoveApplicationInstanceRequest":{ + "type":"structure", + "required":["ApplicationInstanceId"], + "members":{ + "ApplicationInstanceId":{ + "shape":"ApplicationInstanceId", + "location":"uri", + "locationName":"applicationInstanceId" + } + } + }, + "RemoveApplicationInstanceResponse":{ + "type":"structure", + "members":{ + } + }, + "ResourceArn":{ + "type":"string", + "max":2048, + "min":1, + "pattern":"^.+$" + }, + "ResourceNotFoundException":{ + "type":"structure", + "required":[ + "Message", + "ResourceId", + "ResourceType" + ], + "members":{ + "Message":{"shape":"String"}, + "ResourceId":{"shape":"String"}, + "ResourceType":{"shape":"String"} + }, + "error":{"httpStatusCode":404}, + "exception":true + }, + "RetryAfterSeconds":{"type":"integer"}, + "RuntimeRoleArn":{ + "type":"string", + "max":255, + "min":1, + "pattern":"^arn:[a-z0-9][-.a-z0-9]{0,62}:iam::[0-9]{12}:role/.+$" + }, + "S3Location":{ + "type":"structure", + "required":[ + "BucketName", + "ObjectKey" + ], + "members":{ + "Region":{"shape":"Region"}, + "BucketName":{"shape":"BucketName"}, + "ObjectKey":{"shape":"ObjectKey"} + } + }, + "ServiceQuotaExceededException":{ + "type":"structure", + "required":[ + "Message", + "QuotaCode", + "ServiceCode" + ], + "members":{ + "Message":{"shape":"String"}, + "ResourceId":{"shape":"String"}, + "ResourceType":{"shape":"String"}, + "QuotaCode":{"shape":"String"}, + "ServiceCode":{"shape":"String"} + }, + "error":{"httpStatusCode":402}, + "exception":true + }, + "StaticIpConnectionInfo":{ + "type":"structure", + "required":[ + "IpAddress", + "Mask", + "Dns", + "DefaultGateway" + ], + "members":{ + "IpAddress":{"shape":"IpAddress"}, + "Mask":{"shape":"Mask"}, + "Dns":{"shape":"DnsList"}, + "DefaultGateway":{"shape":"DefaultGateway"} + } + }, + "StatusFilter":{ + "type":"string", + "enum":[ + "DEPLOYMENT_SUCCEEDED", + "DEPLOYMENT_ERROR", + "REMOVAL_SUCCEEDED", + "REMOVAL_FAILED", + "PROCESSING_DEPLOYMENT", + "PROCESSING_REMOVAL" + ] + }, + "StorageLocation":{ + "type":"structure", + "required":[ + "Bucket", + "RepoPrefixLocation", + "GeneratedPrefixLocation", + "BinaryPrefixLocation", + "ManifestPrefixLocation" + ], + "members":{ + "Bucket":{"shape":"Bucket"}, + "RepoPrefixLocation":{"shape":"Object"}, + "GeneratedPrefixLocation":{"shape":"Object"}, + "BinaryPrefixLocation":{"shape":"Object"}, + "ManifestPrefixLocation":{"shape":"Object"} + } + }, + "String":{"type":"string"}, + "TagKey":{ + "type":"string", + "max":128, + "min":1, + "pattern":"^.+$" + }, + "TagKeyList":{ + "type":"list", + "member":{"shape":"TagKey"}, + "max":50, + "min":1 + }, + "TagMap":{ + "type":"map", + "key":{"shape":"TagKey"}, + "value":{"shape":"TagValue"}, + "max":50, + "min":0 + }, + "TagResourceRequest":{ + "type":"structure", + "required":[ + "ResourceArn", + "Tags" + ], + "members":{ + "ResourceArn":{ + "shape":"ResourceArn", + "location":"uri", + "locationName":"ResourceArn" + }, + "Tags":{"shape":"TagMap"} + } + }, + "TagResourceResponse":{ + "type":"structure", + "members":{ + } + }, + "TagValue":{ + "type":"string", + "max":256, + "min":0, + "pattern":"^.*$" + }, + "TemplateKey":{ + "type":"string", + "max":255, + "min":1, + "pattern":"^.+$" + }, + "TemplateParametersMap":{ + "type":"map", + "key":{"shape":"TemplateKey"}, + "value":{"shape":"TemplateValue"} + }, + "TemplateType":{ + "type":"string", + "enum":["RTSP_CAMERA_STREAM"] + }, + "TemplateValue":{ + "type":"string", + "max":255, + "min":1, + "pattern":"^.+$", + "sensitive":true + }, + "TimeStamp":{"type":"timestamp"}, + "Token":{ + "type":"string", + "max":4096, + "min":1, + "pattern":"^.+$" + }, + "UntagResourceRequest":{ + "type":"structure", + "required":[ + "ResourceArn", + "TagKeys" + ], + "members":{ + "ResourceArn":{ + "shape":"ResourceArn", + "location":"uri", + "locationName":"ResourceArn" + }, + "TagKeys":{ + "shape":"TagKeyList", + "location":"querystring", + "locationName":"tagKeys" + } + } + }, + "UntagResourceResponse":{ + "type":"structure", + "members":{ + } + }, + "UpdateCreatedTime":{"type":"timestamp"}, + "UpdateDeviceMetadataRequest":{ + "type":"structure", + "required":["DeviceId"], + "members":{ + "DeviceId":{ + "shape":"DeviceId", + "location":"uri", + "locationName":"DeviceId" + }, + "Description":{"shape":"Description"} + } + }, + "UpdateDeviceMetadataResponse":{ + "type":"structure", + "members":{ + "DeviceId":{"shape":"DeviceId"} + } + }, + "UpdateProgress":{ + "type":"string", + "enum":[ + "PENDING", + "IN_PROGRESS", + "VERIFYING", + "REBOOTING", + "DOWNLOADING", + "COMPLETED", + "FAILED" + ] + }, + "ValidationException":{ + "type":"structure", + "required":["Message"], + "members":{ + "Message":{"shape":"String"}, + "Reason":{"shape":"ValidationExceptionReason"}, + "ErrorId":{"shape":"String"}, + "ErrorArguments":{"shape":"ValidationExceptionErrorArgumentList"}, + "Fields":{"shape":"ValidationExceptionFieldList"} + }, + "error":{"httpStatusCode":400}, + "exception":true + }, + "ValidationExceptionErrorArgument":{ + "type":"structure", + "required":[ + "Name", + "Value" + ], + "members":{ + "Name":{"shape":"String"}, + "Value":{"shape":"String"} + } + }, + "ValidationExceptionErrorArgumentList":{ + "type":"list", + "member":{"shape":"ValidationExceptionErrorArgument"} + }, + "ValidationExceptionField":{ + "type":"structure", + "required":[ + "Name", + "Message" + ], + "members":{ + "Name":{"shape":"String"}, + "Message":{"shape":"String"} + } + }, + "ValidationExceptionFieldList":{ + "type":"list", + "member":{"shape":"ValidationExceptionField"} + }, + "ValidationExceptionReason":{ + "type":"string", + "enum":[ + "UNKNOWN_OPERATION", + "CANNOT_PARSE", + "FIELD_VALIDATION_FAILED", + "OTHER" + ] + } + } +} diff --git a/models/apis/panorama/2019-07-24/docs-2.json b/models/apis/panorama/2019-07-24/docs-2.json new file mode 100644 index 0000000000..d54a44dab7 --- /dev/null +++ b/models/apis/panorama/2019-07-24/docs-2.json @@ -0,0 +1,1486 @@ +{ + "version": "2.0", + "service": "Overview
This is the AWS Panorama API Reference. For an introduction to the service, see What is AWS Panorama? in the AWS Panorama Developer Guide.
", + "operations": { + "CreateApplicationInstance": "Creates an application instance and deploys it to a device.
", + "CreateJobForDevices": "Creates a job to run on one or more devices.
", + "CreateNodeFromTemplateJob": "Creates a camera stream node.
", + "CreatePackage": "Creates a package and storage location in an Amazon S3 access point.
", + "CreatePackageImportJob": "Imports a node package.
", + "DeleteDevice": "Deletes a device.
", + "DeletePackage": "Deletes a package.
", + "DeregisterPackageVersion": "Deregisters a package version.
", + "DescribeApplicationInstance": "Returns information about an application instance on a device.
", + "DescribeApplicationInstanceDetails": "Returns information about an application instance's configuration manifest.
", + "DescribeDevice": "Returns information about a device.
", + "DescribeDeviceJob": "Returns information about a device job.
", + "DescribeNode": "Returns information about a node.
", + "DescribeNodeFromTemplateJob": "Returns information about a job to create a camera stream node.
", + "DescribePackage": "Returns information about a package.
", + "DescribePackageImportJob": "Returns information about a package import job.
", + "DescribePackageVersion": "Returns information about a package version.
", + "ListApplicationInstanceDependencies": "Returns a list of application instance dependencies.
", + "ListApplicationInstanceNodeInstances": "Returns a list of application node instances.
", + "ListApplicationInstances": "Returns a list of application instances.
", + "ListDevices": "Returns a list of devices.
", + "ListDevicesJobs": "Returns a list of jobs.
", + "ListNodeFromTemplateJobs": "Returns a list of camera stream node jobs.
", + "ListNodes": "Returns a list of nodes.
", + "ListPackageImportJobs": "Returns a list of package import jobs.
", + "ListPackages": "Returns a list of packages.
", + "ListTagsForResource": "Returns a list of tags for a resource.
", + "ProvisionDevice": "Creates a device and returns a configuration archive. The configuration archive is a ZIP file that contains a provisioning certificate that is valid for 5 minutes. Transfer the configuration archive to the device with the included USB storage device within 5 minutes.
", + "RegisterPackageVersion": "Registers a package version.
", + "RemoveApplicationInstance": "Removes an application instance.
", + "TagResource": "Tags a resource.
", + "UntagResource": "Removes tags from a resource.
", + "UpdateDeviceMetadata": "Updates a device's metadata.
" + }, + "shapes": { + "AccessDeniedException": { + "base": "The requestor does not have permission to access the target action or resource.
", + "refs": { + } + }, + "ApplicationInstance": { + "base": "An application instance on a device.
", + "refs": { + "ApplicationInstances$member": null + } + }, + "ApplicationInstanceArn": { + "base": null, + "refs": { + "ApplicationInstance$Arn": "The application instance's ARN.
", + "DescribeApplicationInstanceResponse$Arn": "The application instance's ARN.
" + } + }, + "ApplicationInstanceHealthStatus": { + "base": null, + "refs": { + "ApplicationInstance$HealthStatus": "The application instance's health status.
", + "DescribeApplicationInstanceResponse$HealthStatus": "The application instance's health status.
" + } + }, + "ApplicationInstanceId": { + "base": null, + "refs": { + "ApplicationInstance$ApplicationInstanceId": "The application instance's ID.
", + "CreateApplicationInstanceRequest$ApplicationInstanceIdToReplace": "The ID of an application instance to replace with the new instance.
", + "CreateApplicationInstanceResponse$ApplicationInstanceId": "The application instance's ID.
", + "DescribeApplicationInstanceDetailsRequest$ApplicationInstanceId": "The application instance's ID.
", + "DescribeApplicationInstanceDetailsResponse$ApplicationInstanceIdToReplace": "The ID of the application instance that this instance replaced.
", + "DescribeApplicationInstanceDetailsResponse$ApplicationInstanceId": "The application instance's ID.
", + "DescribeApplicationInstanceRequest$ApplicationInstanceId": "The application instance's ID.
", + "DescribeApplicationInstanceResponse$ApplicationInstanceIdToReplace": "The ID of the application instance that this instance replaced.
", + "DescribeApplicationInstanceResponse$ApplicationInstanceId": "The application instance's ID.
", + "ListApplicationInstanceDependenciesRequest$ApplicationInstanceId": "The application instance's ID.
", + "ListApplicationInstanceNodeInstancesRequest$ApplicationInstanceId": "The node instances' application instance ID.
", + "RemoveApplicationInstanceRequest$ApplicationInstanceId": "An application instance ID.
" + } + }, + "ApplicationInstanceName": { + "base": null, + "refs": { + "ApplicationInstance$Name": "The application instance's name.
", + "CreateApplicationInstanceRequest$Name": "A name for the application instance.
", + "DescribeApplicationInstanceDetailsResponse$Name": "The application instance's name.
", + "DescribeApplicationInstanceResponse$Name": "The application instance's name.
" + } + }, + "ApplicationInstanceStatus": { + "base": null, + "refs": { + "ApplicationInstance$Status": "The application instance's status.
", + "DescribeApplicationInstanceResponse$Status": "The application instance's status.
" + } + }, + "ApplicationInstanceStatusDescription": { + "base": null, + "refs": { + "ApplicationInstance$StatusDescription": "The application instance's status description.
", + "DescribeApplicationInstanceResponse$StatusDescription": "The application instance's status description.
" + } + }, + "ApplicationInstances": { + "base": null, + "refs": { + "ListApplicationInstancesResponse$ApplicationInstances": "A list of application instances.
" + } + }, + "Boolean": { + "base": null, + "refs": { + "DeletePackageRequest$ForceDelete": "Delete the package even if it has artifacts stored in its access point. Deletes the package's artifacts from Amazon S3.
", + "DescribePackageVersionResponse$IsLatestPatch": "Whether the version is the latest available.
" + } + }, + "Bucket": { + "base": null, + "refs": { + "StorageLocation$Bucket": "The location's bucket.
" + } + }, + "BucketName": { + "base": null, + "refs": { + "OutPutS3Location$BucketName": "The object's bucket.
", + "S3Location$BucketName": "A bucket name.
" + } + }, + "Certificates": { + "base": null, + "refs": { + "ProvisionDeviceResponse$Certificates": "The device's configuration bundle.
" + } + }, + "ClientToken": { + "base": null, + "refs": { + "CreatePackageImportJobRequest$ClientToken": "A client token for the package import job.
", + "DescribePackageImportJobResponse$ClientToken": "The job's client token.
" + } + }, + "ConflictException": { + "base": "The target resource is in use.
", + "refs": { + } + }, + "ConflictExceptionErrorArgument": { + "base": "A conflict exception error argument.
", + "refs": { + "ConflictExceptionErrorArgumentList$member": null + } + }, + "ConflictExceptionErrorArgumentList": { + "base": null, + "refs": { + "ConflictException$ErrorArguments": "A list of attributes that led to the exception and their values.
" + } + }, + "ConnectionType": { + "base": null, + "refs": { + "EthernetPayload$ConnectionType": "How the device gets an IP address.
" + } + }, + "CreateApplicationInstanceRequest": { + "base": null, + "refs": { + } + }, + "CreateApplicationInstanceResponse": { + "base": null, + "refs": { + } + }, + "CreateJobForDevicesRequest": { + "base": null, + "refs": { + } + }, + "CreateJobForDevicesResponse": { + "base": null, + "refs": { + } + }, + "CreateNodeFromTemplateJobRequest": { + "base": null, + "refs": { + } + }, + "CreateNodeFromTemplateJobResponse": { + "base": null, + "refs": { + } + }, + "CreatePackageImportJobRequest": { + "base": null, + "refs": { + } + }, + "CreatePackageImportJobResponse": { + "base": null, + "refs": { + } + }, + "CreatePackageRequest": { + "base": null, + "refs": { + } + }, + "CreatePackageResponse": { + "base": null, + "refs": { + } + }, + "CreatedTime": { + "base": null, + "refs": { + "DescribeDeviceResponse$CreatedTime": "When the device was created.
", + "DescribeNodeFromTemplateJobResponse$CreatedTime": "When the job was created.
", + "DescribePackageImportJobResponse$CreatedTime": "When the job was created.
", + "Device$CreatedTime": "When the device was created.
", + "DeviceJob$CreatedTime": "When the job was created.
", + "NodeFromTemplateJob$CreatedTime": "When the job was created.
", + "PackageImportJob$CreatedTime": "When the job was created.
" + } + }, + "CurrentSoftware": { + "base": null, + "refs": { + "DescribeDeviceResponse$CurrentSoftware": "The device's current software version.
" + } + }, + "DefaultGateway": { + "base": null, + "refs": { + "StaticIpConnectionInfo$DefaultGateway": "The connection's default gateway.
" + } + }, + "DefaultRuntimeContextDevice": { + "base": null, + "refs": { + "ApplicationInstance$DefaultRuntimeContextDevice": "The device's ID.
", + "CreateApplicationInstanceRequest$DefaultRuntimeContextDevice": "A device's ID.
", + "DescribeApplicationInstanceDetailsResponse$DefaultRuntimeContextDevice": "The application instance's default runtime context device.
", + "DescribeApplicationInstanceResponse$DefaultRuntimeContextDevice": "The device's ID.
" + } + }, + "DeleteDeviceRequest": { + "base": null, + "refs": { + } + }, + "DeleteDeviceResponse": { + "base": null, + "refs": { + } + }, + "DeletePackageRequest": { + "base": null, + "refs": { + } + }, + "DeletePackageResponse": { + "base": null, + "refs": { + } + }, + "DeregisterPackageVersionRequest": { + "base": null, + "refs": { + } + }, + "DeregisterPackageVersionResponse": { + "base": null, + "refs": { + } + }, + "DescribeApplicationInstanceDetailsRequest": { + "base": null, + "refs": { + } + }, + "DescribeApplicationInstanceDetailsResponse": { + "base": null, + "refs": { + } + }, + "DescribeApplicationInstanceRequest": { + "base": null, + "refs": { + } + }, + "DescribeApplicationInstanceResponse": { + "base": null, + "refs": { + } + }, + "DescribeDeviceJobRequest": { + "base": null, + "refs": { + } + }, + "DescribeDeviceJobResponse": { + "base": null, + "refs": { + } + }, + "DescribeDeviceRequest": { + "base": null, + "refs": { + } + }, + "DescribeDeviceResponse": { + "base": null, + "refs": { + } + }, + "DescribeNodeFromTemplateJobRequest": { + "base": null, + "refs": { + } + }, + "DescribeNodeFromTemplateJobResponse": { + "base": null, + "refs": { + } + }, + "DescribeNodeRequest": { + "base": null, + "refs": { + } + }, + "DescribeNodeResponse": { + "base": null, + "refs": { + } + }, + "DescribePackageImportJobRequest": { + "base": null, + "refs": { + } + }, + "DescribePackageImportJobResponse": { + "base": null, + "refs": { + } + }, + "DescribePackageRequest": { + "base": null, + "refs": { + } + }, + "DescribePackageResponse": { + "base": null, + "refs": { + } + }, + "DescribePackageVersionRequest": { + "base": null, + "refs": { + } + }, + "DescribePackageVersionResponse": { + "base": null, + "refs": { + } + }, + "Description": { + "base": null, + "refs": { + "ApplicationInstance$Description": "The application instance's description.
", + "CreateApplicationInstanceRequest$Description": "A description for the application instance.
", + "CreateNodeFromTemplateJobRequest$NodeDescription": "A description for the node.
", + "DescribeApplicationInstanceDetailsResponse$Description": "The application instance's description.
", + "DescribeApplicationInstanceResponse$Description": "The application instance's description.
", + "DescribeDeviceResponse$Description": "The device's description.
", + "DescribeNodeFromTemplateJobResponse$NodeDescription": "The node's description.
", + "DescribeNodeResponse$Description": "The node's description.
", + "Node$Description": "The node's description.
", + "NodeInputPort$Description": "The input port's description.
", + "NodeOutputPort$Description": "The output port's description.
", + "ProvisionDeviceRequest$Description": "A description for the device.
", + "UpdateDeviceMetadataRequest$Description": "A description for the device.
" + } + }, + "Device": { + "base": "A device.
", + "refs": { + "DeviceList$member": null + } + }, + "DeviceArn": { + "base": null, + "refs": { + "DescribeDeviceJobResponse$DeviceArn": "The device's ARN.
", + "DescribeDeviceResponse$Arn": "The device's ARN.
", + "ProvisionDeviceResponse$Arn": "The device's ARN.
" + } + }, + "DeviceConnectionStatus": { + "base": null, + "refs": { + "DescribeDeviceResponse$DeviceConnectionStatus": "The device's connection status.
" + } + }, + "DeviceId": { + "base": null, + "refs": { + "DeleteDeviceRequest$DeviceId": "The device's ID.
", + "DeleteDeviceResponse$DeviceId": "The device's ID.
", + "DescribeDeviceJobResponse$DeviceId": "The device's ID.
", + "DescribeDeviceRequest$DeviceId": "The device's ID.
", + "DescribeDeviceResponse$DeviceId": "The device's ID.
", + "Device$DeviceId": "The device's ID.
", + "DeviceIdList$member": null, + "DeviceJob$DeviceId": "The ID of the target device.
", + "Job$DeviceId": "The target device's ID.
", + "ListApplicationInstancesRequest$DeviceId": "The application instances' device ID.
", + "ListDevicesJobsRequest$DeviceId": "Filter results by the job's target device ID.
", + "ProvisionDeviceResponse$DeviceId": "The device's ID.
", + "UpdateDeviceMetadataRequest$DeviceId": "The device's ID.
", + "UpdateDeviceMetadataResponse$DeviceId": "The device's ID.
" + } + }, + "DeviceIdList": { + "base": null, + "refs": { + "CreateJobForDevicesRequest$DeviceIds": "IDs of target devices.
" + } + }, + "DeviceJob": { + "base": "A job that runs on a device.
", + "refs": { + "DeviceJobList$member": null + } + }, + "DeviceJobConfig": { + "base": "A job's configuration.
", + "refs": { + "CreateJobForDevicesRequest$DeviceJobConfig": "Configuration settings for the job.
" + } + }, + "DeviceJobList": { + "base": null, + "refs": { + "ListDevicesJobsResponse$DeviceJobs": "A list of jobs.
" + } + }, + "DeviceList": { + "base": null, + "refs": { + "ListDevicesResponse$Devices": "A list of devices.
" + } + }, + "DeviceName": { + "base": null, + "refs": { + "ApplicationInstance$DefaultRuntimeContextDeviceName": "The device's name.
", + "DescribeApplicationInstanceResponse$DefaultRuntimeContextDeviceName": "The device's bane.
", + "DescribeDeviceJobResponse$DeviceName": "The device's name.
", + "DescribeDeviceResponse$Name": "The device's name.
", + "Device$Name": "The device's name.
", + "DeviceJob$DeviceName": "The name of the target device
", + "ProvisionDeviceRequest$Name": "A name for the device.
" + } + }, + "DeviceSerialNumber": { + "base": null, + "refs": { + "DescribeDeviceResponse$SerialNumber": "The device's serial number.
" + } + }, + "DeviceStatus": { + "base": null, + "refs": { + "DescribeDeviceResponse$ProvisioningStatus": "The device's provisioning status.
", + "Device$ProvisioningStatus": "The device's provisioning status.
", + "ProvisionDeviceResponse$Status": "The device's status.
" + } + }, + "DeviceType": { + "base": null, + "refs": { + "DescribeDeviceJobResponse$DeviceType": "The device's type.
", + "DescribeDeviceResponse$Type": "The device's type.
" + } + }, + "Dns": { + "base": null, + "refs": { + "DnsList$member": null + } + }, + "DnsList": { + "base": null, + "refs": { + "StaticIpConnectionInfo$Dns": "The connection's DNS address.
" + } + }, + "EthernetPayload": { + "base": "A device's network configuration.
", + "refs": { + "NetworkPayload$Ethernet0": "Settings for Ethernet port 0.
", + "NetworkPayload$Ethernet1": "Settings for Ethernet port 1.
" + } + }, + "EthernetStatus": { + "base": "A device's Ethernet status.
", + "refs": { + "NetworkStatus$Ethernet0Status": "The status of Ethernet port 0.
", + "NetworkStatus$Ethernet1Status": "The status of Ethernet port 1.
" + } + }, + "HwAddress": { + "base": null, + "refs": { + "EthernetStatus$HwAddress": "The device's physical address.
" + } + }, + "ImageVersion": { + "base": null, + "refs": { + "DescribeDeviceJobResponse$ImageVersion": "For an OTA job, the target version of the device software.
", + "OTAJobConfig$ImageVersion": "The target version of the device software.
" + } + }, + "InputPortList": { + "base": null, + "refs": { + "NodeInterface$Inputs": "The node interface's inputs.
" + } + }, + "InternalServerException": { + "base": "An internal error occurred.
", + "refs": { + } + }, + "IotThingName": { + "base": null, + "refs": { + "ProvisionDeviceResponse$IotThingName": "The device's IoT thing name.
" + } + }, + "IpAddress": { + "base": null, + "refs": { + "EthernetStatus$IpAddress": "The device's IP address.
", + "StaticIpConnectionInfo$IpAddress": "The connection's IP address.
" + } + }, + "Job": { + "base": "A job for a device.
", + "refs": { + "JobList$member": null + } + }, + "JobId": { + "base": null, + "refs": { + "CreateNodeFromTemplateJobResponse$JobId": "The job's ID.
", + "CreatePackageImportJobResponse$JobId": "The job's ID.
", + "DescribeDeviceJobRequest$JobId": "The job's ID.
", + "DescribeDeviceJobResponse$JobId": "The job's ID.
", + "DescribeNodeFromTemplateJobRequest$JobId": "The job's ID.
", + "DescribeNodeFromTemplateJobResponse$JobId": "The job's ID.
", + "DescribePackageImportJobRequest$JobId": "The job's ID.
", + "DescribePackageImportJobResponse$JobId": "The job's ID.
", + "DeviceJob$JobId": "The job's ID.
", + "Job$JobId": "The job's ID.
", + "NodeFromTemplateJob$JobId": "The job's ID.
", + "PackageImportJob$JobId": "The job's ID.
" + } + }, + "JobList": { + "base": null, + "refs": { + "CreateJobForDevicesResponse$Jobs": "A list of jobs.
" + } + }, + "JobResourceTags": { + "base": "Tags for a job.
", + "refs": { + "JobTagsList$member": null + } + }, + "JobResourceType": { + "base": null, + "refs": { + "JobResourceTags$ResourceType": "The job's type.
" + } + }, + "JobTagsList": { + "base": null, + "refs": { + "CreateNodeFromTemplateJobRequest$JobTags": "Tags for the job.
", + "CreatePackageImportJobRequest$JobTags": "Tags for the package import job.
", + "DescribeNodeFromTemplateJobResponse$JobTags": "The job's tags.
", + "DescribePackageImportJobResponse$JobTags": "The job's tags.
" + } + }, + "JobType": { + "base": null, + "refs": { + "CreateJobForDevicesRequest$JobType": "The type of job to run.
" + } + }, + "LastUpdatedTime": { + "base": null, + "refs": { + "DescribeNodeFromTemplateJobResponse$LastUpdatedTime": "When the job was updated.
", + "DescribePackageImportJobResponse$LastUpdatedTime": "When the job was updated.
", + "Device$LastUpdatedTime": "When the device was updated.
", + "PackageImportJob$LastUpdatedTime": "When the job was updated.
" + } + }, + "LatestSoftware": { + "base": null, + "refs": { + "DescribeDeviceResponse$LatestSoftware": "The latest software version available for the device.
" + } + }, + "LeaseExpirationTime": { + "base": null, + "refs": { + "DescribeDeviceResponse$LeaseExpirationTime": "The device's lease expiration time.
", + "Device$LeaseExpirationTime": "The device's lease expiration time.
" + } + }, + "ListApplicationInstanceDependenciesRequest": { + "base": null, + "refs": { + } + }, + "ListApplicationInstanceDependenciesResponse": { + "base": null, + "refs": { + } + }, + "ListApplicationInstanceNodeInstancesRequest": { + "base": null, + "refs": { + } + }, + "ListApplicationInstanceNodeInstancesResponse": { + "base": null, + "refs": { + } + }, + "ListApplicationInstancesRequest": { + "base": null, + "refs": { + } + }, + "ListApplicationInstancesResponse": { + "base": null, + "refs": { + } + }, + "ListDevicesJobsRequest": { + "base": null, + "refs": { + } + }, + "ListDevicesJobsResponse": { + "base": null, + "refs": { + } + }, + "ListDevicesRequest": { + "base": null, + "refs": { + } + }, + "ListDevicesResponse": { + "base": null, + "refs": { + } + }, + "ListNodeFromTemplateJobsRequest": { + "base": null, + "refs": { + } + }, + "ListNodeFromTemplateJobsResponse": { + "base": null, + "refs": { + } + }, + "ListNodesRequest": { + "base": null, + "refs": { + } + }, + "ListNodesResponse": { + "base": null, + "refs": { + } + }, + "ListPackageImportJobsRequest": { + "base": null, + "refs": { + } + }, + "ListPackageImportJobsResponse": { + "base": null, + "refs": { + } + }, + "ListPackagesRequest": { + "base": null, + "refs": { + } + }, + "ListPackagesResponse": { + "base": null, + "refs": { + } + }, + "ListTagsForResourceRequest": { + "base": null, + "refs": { + } + }, + "ListTagsForResourceResponse": { + "base": null, + "refs": { + } + }, + "ManifestOverridesPayload": { + "base": "Parameter overrides for an application instance. This is a JSON document that has a single key (PayloadData) where the value is an escaped string representation of the overrides document.
Setting overrides for the application manifest.
", + "DescribeApplicationInstanceDetailsResponse$ManifestOverridesPayload": "Parameter overrides for the configuration manifest.
" + } + }, + "ManifestOverridesPayloadData": { + "base": null, + "refs": { + "ManifestOverridesPayload$PayloadData": "The overrides document.
" + } + }, + "ManifestPayload": { + "base": "A application verion's manifest file. This is a JSON document that has a single key (PayloadData) where the value is an escaped string representation of the application manifest (graph.json). This file is located in the graphs folder in your application source.
The application's manifest document.
", + "DescribeApplicationInstanceDetailsResponse$ManifestPayload": "The application instance's configuration manifest.
" + } + }, + "ManifestPayloadData": { + "base": null, + "refs": { + "ManifestPayload$PayloadData": "The application manifest.
" + } + }, + "MarkLatestPatch": { + "base": null, + "refs": { + "PackageVersionOutputConfig$MarkLatest": "Indicates that the version is recommended for all users.
", + "RegisterPackageVersionRequest$MarkLatest": "Whether to mark the new version as the latest version.
" + } + }, + "Mask": { + "base": null, + "refs": { + "StaticIpConnectionInfo$Mask": "The connection's DNS mask.
" + } + }, + "MaxConnections": { + "base": null, + "refs": { + "NodeInputPort$MaxConnections": "The input port's max connections.
" + } + }, + "MaxSize25": { + "base": null, + "refs": { + "ListApplicationInstanceDependenciesRequest$MaxResults": "The maximum number of application instance dependencies to return in one page of results.
", + "ListApplicationInstanceNodeInstancesRequest$MaxResults": "The maximum number of node instances to return in one page of results.
", + "ListApplicationInstancesRequest$MaxResults": "The maximum number of application instances to return in one page of results.
", + "ListDevicesJobsRequest$MaxResults": "The maximum number of device jobs to return in one page of results.
", + "ListDevicesRequest$MaxResults": "The maximum number of devices to return in one page of results.
", + "ListNodeFromTemplateJobsRequest$MaxResults": "The maximum number of node from template jobs to return in one page of results.
", + "ListNodesRequest$MaxResults": "The maximum number of nodes to return in one page of results.
", + "ListPackageImportJobsRequest$MaxResults": "The maximum number of package import jobs to return in one page of results.
", + "ListPackagesRequest$MaxResults": "The maximum number of packages to return in one page of results.
" + } + }, + "NetworkConnectionStatus": { + "base": null, + "refs": { + "EthernetStatus$ConnectionStatus": "The device's connection status.
" + } + }, + "NetworkPayload": { + "base": "The network configuration for a device.
", + "refs": { + "DescribeDeviceResponse$NetworkingConfiguration": "The device's networking configuration.
", + "ProvisionDeviceRequest$NetworkingConfiguration": "A networking configuration for the device.
" + } + }, + "NetworkStatus": { + "base": "The network status of a device.
", + "refs": { + "DescribeDeviceResponse$CurrentNetworkingStatus": "The device's networking status.
" + } + }, + "NextToken": { + "base": null, + "refs": { + "ListApplicationInstanceDependenciesRequest$NextToken": "Specify the pagination token from a previous request to retrieve the next page of results.
", + "ListApplicationInstanceDependenciesResponse$NextToken": "A pagination token that's included if more results are available.
", + "ListApplicationInstanceNodeInstancesRequest$NextToken": "Specify the pagination token from a previous request to retrieve the next page of results.
", + "ListApplicationInstanceNodeInstancesResponse$NextToken": "A pagination token that's included if more results are available.
", + "ListApplicationInstancesRequest$NextToken": "Specify the pagination token from a previous request to retrieve the next page of results.
", + "ListApplicationInstancesResponse$NextToken": "A pagination token that's included if more results are available.
", + "ListDevicesJobsRequest$NextToken": "Specify the pagination token from a previous request to retrieve the next page of results.
", + "ListDevicesJobsResponse$NextToken": "A pagination token that's included if more results are available.
", + "ListDevicesRequest$NextToken": "Specify the pagination token from a previous request to retrieve the next page of results.
", + "ListDevicesResponse$NextToken": "A pagination token that's included if more results are available.
", + "ListNodeFromTemplateJobsRequest$NextToken": "Specify the pagination token from a previous request to retrieve the next page of results.
", + "ListNodeFromTemplateJobsResponse$NextToken": "A pagination token that's included if more results are available.
", + "ListPackageImportJobsRequest$NextToken": "Specify the pagination token from a previous request to retrieve the next page of results.
", + "ListPackageImportJobsResponse$NextToken": "A pagination token that's included if more results are available.
", + "ListPackagesResponse$NextToken": "A pagination token that's included if more results are available.
" + } + }, + "Node": { + "base": "An application node that represents a camera stream, a model, code, or output.
", + "refs": { + "NodesList$member": null + } + }, + "NodeAssetName": { + "base": null, + "refs": { + "DescribeNodeResponse$AssetName": "The node's asset name.
" + } + }, + "NodeCategory": { + "base": null, + "refs": { + "DescribeNodeResponse$Category": "The node's category.
", + "ListNodesRequest$Category": "Search for nodes by category.
", + "Node$Category": "The node's category.
" + } + }, + "NodeFromTemplateJob": { + "base": "A job to create a camera stream node.
", + "refs": { + "NodeFromTemplateJobList$member": null + } + }, + "NodeFromTemplateJobList": { + "base": null, + "refs": { + "ListNodeFromTemplateJobsResponse$NodeFromTemplateJobs": "A list of jobs.
" + } + }, + "NodeFromTemplateJobStatus": { + "base": null, + "refs": { + "DescribeNodeFromTemplateJobResponse$Status": "The job's status.
", + "NodeFromTemplateJob$Status": "The job's status.
" + } + }, + "NodeFromTemplateJobStatusMessage": { + "base": null, + "refs": { + "DescribeNodeFromTemplateJobResponse$StatusMessage": "The job's status message.
", + "NodeFromTemplateJob$StatusMessage": "The job's status message.
" + } + }, + "NodeId": { + "base": null, + "refs": { + "DescribeNodeRequest$NodeId": "The node's ID.
", + "DescribeNodeResponse$NodeId": "The node's ID.
", + "Node$NodeId": "The node's ID.
", + "NodeInstance$NodeId": "The node's ID.
" + } + }, + "NodeInputPort": { + "base": "A node input port.
", + "refs": { + "InputPortList$member": null + } + }, + "NodeInstance": { + "base": "A node instance.
", + "refs": { + "NodeInstances$member": null + } + }, + "NodeInstanceId": { + "base": null, + "refs": { + "NodeInstance$NodeInstanceId": "The instance's ID.
" + } + }, + "NodeInstanceStatus": { + "base": null, + "refs": { + "NodeInstance$CurrentStatus": "The instance's current status.
" + } + }, + "NodeInstances": { + "base": null, + "refs": { + "ListApplicationInstanceNodeInstancesResponse$NodeInstances": "A list of node instances.
" + } + }, + "NodeInterface": { + "base": "A node interface.
", + "refs": { + "DescribeNodeResponse$NodeInterface": "The node's interface.
" + } + }, + "NodeName": { + "base": null, + "refs": { + "CreateNodeFromTemplateJobRequest$NodeName": "A name for the node.
", + "DescribeNodeFromTemplateJobResponse$NodeName": "The node's name.
", + "DescribeNodeResponse$Name": "The node's name.
", + "Node$Name": "The node's name.
", + "NodeFromTemplateJob$NodeName": "The node's name.
", + "NodeInstance$NodeName": "The instance's name.
" + } + }, + "NodeOutputPort": { + "base": "A node output port.
", + "refs": { + "OutputPortList$member": null + } + }, + "NodePackageArn": { + "base": null, + "refs": { + "CreatePackageResponse$Arn": "The package's ARN.
", + "DescribeNodeResponse$PackageArn": "The node's ARN.
", + "DescribePackageResponse$Arn": "The package's ARN.
", + "DescribePackageVersionResponse$PackageArn": "The ARN of the package.
", + "Node$PackageArn": "The node's ARN.
", + "PackageListItem$Arn": "The package's ARN.
" + } + }, + "NodePackageId": { + "base": null, + "refs": { + "CreatePackageResponse$PackageId": "The package's ID.
", + "DeletePackageRequest$PackageId": "The package's ID.
", + "DeregisterPackageVersionRequest$PackageId": "A package ID.
", + "DescribeNodeResponse$PackageId": "The node's package ID.
", + "DescribePackageRequest$PackageId": "The package's ID.
", + "DescribePackageResponse$PackageId": "The package's ID.
", + "DescribePackageVersionRequest$PackageId": "The version's ID.
", + "DescribePackageVersionResponse$PackageId": "The version's ID.
", + "Node$PackageId": "The node's package ID.
", + "PackageImportJobOutput$PackageId": "The package's ID.
", + "PackageListItem$PackageId": "The package's ID.
", + "RegisterPackageVersionRequest$PackageId": "A package ID.
" + } + }, + "NodePackageName": { + "base": null, + "refs": { + "CreateNodeFromTemplateJobRequest$OutputPackageName": "An output package name for the node.
", + "CreatePackageRequest$PackageName": "A name for the package.
", + "DescribeNodeFromTemplateJobResponse$OutputPackageName": "The job's output package name.
", + "DescribeNodeResponse$PackageName": "The node's package name.
", + "DescribePackageResponse$PackageName": "The package's name.
", + "DescribePackageVersionResponse$PackageName": "The version's name.
", + "ListNodesRequest$PackageName": "Search for nodes by name.
", + "Node$PackageName": "The node's package name.
", + "NodeInstance$PackageName": "The instance's package name.
", + "PackageListItem$PackageName": "The package's name.
", + "PackageObject$Name": "The object's name.
", + "PackageVersionOutputConfig$PackageName": "The output's package name.
" + } + }, + "NodePackagePatchVersion": { + "base": null, + "refs": { + "DeregisterPackageVersionRequest$PatchVersion": "A patch version.
", + "DeregisterPackageVersionRequest$UpdatedLatestPatchVersion": "If the version was marked latest, the new version to maker as latest.
", + "DescribeNodeResponse$PatchVersion": "The node's patch version.
", + "DescribePackageVersionRequest$PatchVersion": "The version's patch version.
", + "DescribePackageVersionResponse$PatchVersion": "The version's patch version.
", + "ListNodesRequest$PatchVersion": "Search for nodes by patch version.
", + "Node$PatchVersion": "The node's patch version.
", + "NodeInstance$PackagePatchVersion": "The instance's package patch version.
", + "PackageImportJobOutput$PatchVersion": "The package's patch version.
", + "PackageObject$PatchVersion": "The object's patch version.
", + "RegisterPackageVersionRequest$PatchVersion": "A patch version.
" + } + }, + "NodePackageVersion": { + "base": null, + "refs": { + "CreateNodeFromTemplateJobRequest$OutputPackageVersion": "An output package version for the node.
", + "DeregisterPackageVersionRequest$PackageVersion": "A package version.
", + "DescribeNodeFromTemplateJobResponse$OutputPackageVersion": "The job's output package version.
", + "DescribeNodeResponse$PackageVersion": "The node's package version.
", + "DescribePackageVersionRequest$PackageVersion": "The version's version.
", + "DescribePackageVersionResponse$PackageVersion": "The version's version.
", + "ListNodesRequest$PackageVersion": "Search for nodes by version.
", + "Node$PackageVersion": "The node's package version.
", + "NodeInstance$PackageVersion": "The instance's package version.
", + "PackageImportJobOutput$PackageVersion": "The package's version.
", + "PackageObject$PackageVersion": "The object's package version.
", + "PackageVersionOutputConfig$PackageVersion": "The output's package version.
", + "RegisterPackageVersionRequest$PackageVersion": "A package version.
" + } + }, + "NodesList": { + "base": null, + "refs": { + "ListNodesResponse$Nodes": "A list of nodes.
" + } + }, + "OTAJobConfig": { + "base": "An over-the-air update (OTA) job configuration.
", + "refs": { + "DeviceJobConfig$OTAJobConfig": "A configuration for an over-the-air (OTA) upgrade. Required for OTA jobs.
" + } + }, + "Object": { + "base": null, + "refs": { + "StorageLocation$RepoPrefixLocation": "The location's repo prefix.
", + "StorageLocation$GeneratedPrefixLocation": "The location's generated prefix.
", + "StorageLocation$BinaryPrefixLocation": "The location's binary prefix.
", + "StorageLocation$ManifestPrefixLocation": "The location's manifest prefix.
" + } + }, + "ObjectKey": { + "base": null, + "refs": { + "OutPutS3Location$ObjectKey": "The object's key.
", + "S3Location$ObjectKey": "An object key.
" + } + }, + "OutPutS3Location": { + "base": "The location of an output object in Amazon S3.
", + "refs": { + "PackageImportJobOutput$OutputS3Location": "The package's output location.
" + } + }, + "OutputPortList": { + "base": null, + "refs": { + "NodeInterface$Outputs": "The node interface's outputs.
" + } + }, + "PackageImportJob": { + "base": "A job to import a package version.
", + "refs": { + "PackageImportJobList$member": null + } + }, + "PackageImportJobInputConfig": { + "base": "A configuration for a package import job.
", + "refs": { + "CreatePackageImportJobRequest$InputConfig": "An input config for the package import job.
", + "DescribePackageImportJobResponse$InputConfig": "The job's input config.
" + } + }, + "PackageImportJobList": { + "base": null, + "refs": { + "ListPackageImportJobsResponse$PackageImportJobs": "A list of package import jobs.
" + } + }, + "PackageImportJobOutput": { + "base": "Results of a package import job.
", + "refs": { + "DescribePackageImportJobResponse$Output": "The job's output.
" + } + }, + "PackageImportJobOutputConfig": { + "base": "An output configuration for a package import job.
", + "refs": { + "CreatePackageImportJobRequest$OutputConfig": "An output config for the package import job.
", + "DescribePackageImportJobResponse$OutputConfig": "The job's output config.
" + } + }, + "PackageImportJobStatus": { + "base": null, + "refs": { + "DescribePackageImportJobResponse$Status": "The job's status.
", + "PackageImportJob$Status": "The job's status.
" + } + }, + "PackageImportJobStatusMessage": { + "base": null, + "refs": { + "DescribePackageImportJobResponse$StatusMessage": "The job's status message.
", + "PackageImportJob$StatusMessage": "The job's status message.
" + } + }, + "PackageImportJobType": { + "base": null, + "refs": { + "CreatePackageImportJobRequest$JobType": "A job type for the package import job.
", + "DescribePackageImportJobResponse$JobType": "The job's type.
", + "PackageImportJob$JobType": "The job's type.
" + } + }, + "PackageList": { + "base": null, + "refs": { + "ListPackagesResponse$Packages": "A list of packages.
" + } + }, + "PackageListItem": { + "base": "A package summary.
", + "refs": { + "PackageList$member": null + } + }, + "PackageObject": { + "base": "A package object.
", + "refs": { + "PackageObjects$member": null + } + }, + "PackageObjects": { + "base": null, + "refs": { + "ListApplicationInstanceDependenciesResponse$PackageObjects": "A list of package objects.
" + } + }, + "PackageOwnerAccount": { + "base": null, + "refs": { + "DeregisterPackageVersionRequest$OwnerAccount": "An owner account.
", + "DescribeNodeRequest$OwnerAccount": "The account ID of the node's owner.
", + "DescribeNodeResponse$OwnerAccount": "The account ID of the node's owner.
", + "DescribePackageVersionRequest$OwnerAccount": "The version's owner account.
", + "DescribePackageVersionResponse$OwnerAccount": "The account ID of the version's owner.
", + "ListNodesRequest$OwnerAccount": "Search for nodes by the account ID of the nodes' owner.
", + "Node$OwnerAccount": "The account ID of the node's owner.
", + "RegisterPackageVersionRequest$OwnerAccount": "An owner account.
" + } + }, + "PackageVersionInputConfig": { + "base": "A package version input configuration.
", + "refs": { + "PackageImportJobInputConfig$PackageVersionInputConfig": "The package version's input configuration.
" + } + }, + "PackageVersionOutputConfig": { + "base": "A package version output configuration.
", + "refs": { + "PackageImportJobOutputConfig$PackageVersionOutputConfig": "The package version's output configuration.
" + } + }, + "PackageVersionStatus": { + "base": null, + "refs": { + "DescribePackageVersionResponse$Status": "The version's status.
" + } + }, + "PackageVersionStatusDescription": { + "base": null, + "refs": { + "DescribePackageVersionResponse$StatusDescription": "The version's status description.
" + } + }, + "PortDefaultValue": { + "base": null, + "refs": { + "NodeInputPort$DefaultValue": "The input port's default value.
" + } + }, + "PortName": { + "base": null, + "refs": { + "NodeInputPort$Name": "The input port's name.
", + "NodeOutputPort$Name": "The output port's name.
" + } + }, + "PortType": { + "base": null, + "refs": { + "NodeInputPort$Type": "The input port's type.
", + "NodeOutputPort$Type": "The output port's type.
" + } + }, + "PrincipalArn": { + "base": null, + "refs": { + "PrincipalArnsList$member": null + } + }, + "PrincipalArnsList": { + "base": null, + "refs": { + "DescribePackageResponse$ReadAccessPrincipalArns": "ARNs of accounts that have read access to the package.
", + "DescribePackageResponse$WriteAccessPrincipalArns": "ARNs of accounts that have write access to the package.
" + } + }, + "ProvisionDeviceRequest": { + "base": null, + "refs": { + } + }, + "ProvisionDeviceResponse": { + "base": null, + "refs": { + } + }, + "Region": { + "base": null, + "refs": { + "S3Location$Region": "The bucket's Region.
" + } + }, + "RegisterPackageVersionRequest": { + "base": null, + "refs": { + } + }, + "RegisterPackageVersionResponse": { + "base": null, + "refs": { + } + }, + "RemoveApplicationInstanceRequest": { + "base": null, + "refs": { + } + }, + "RemoveApplicationInstanceResponse": { + "base": null, + "refs": { + } + }, + "ResourceArn": { + "base": null, + "refs": { + "ListTagsForResourceRequest$ResourceArn": "The resource's ARN.
", + "TagResourceRequest$ResourceArn": "The resource's ARN.
", + "UntagResourceRequest$ResourceArn": "The resource's ARN.
" + } + }, + "ResourceNotFoundException": { + "base": "The target resource was not found.
", + "refs": { + } + }, + "RetryAfterSeconds": { + "base": null, + "refs": { + "InternalServerException$RetryAfterSeconds": "The number of seconds a client should wait before retrying the call.
" + } + }, + "RuntimeRoleArn": { + "base": null, + "refs": { + "CreateApplicationInstanceRequest$RuntimeRoleArn": "The ARN of a runtime role for the application instance.
", + "DescribeApplicationInstanceResponse$RuntimeRoleArn": "The application instance's runtime role ARN.
" + } + }, + "S3Location": { + "base": "A location in Amazon S3.
", + "refs": { + "PackageVersionInputConfig$S3Location": "A location in Amazon S3.
" + } + }, + "ServiceQuotaExceededException": { + "base": "The request would cause a limit to be exceeded.
", + "refs": { + } + }, + "StaticIpConnectionInfo": { + "base": "A static IP configuration.
", + "refs": { + "EthernetPayload$StaticIpConnectionInfo": "Network configuration for a static IP connection.
" + } + }, + "StatusFilter": { + "base": null, + "refs": { + "ListApplicationInstancesRequest$StatusFilter": "Only include instances with a specific status.
" + } + }, + "StorageLocation": { + "base": "A storage location.
", + "refs": { + "CreatePackageResponse$StorageLocation": "The package's storage location.
", + "DescribePackageResponse$StorageLocation": "The package's storage location.
" + } + }, + "String": { + "base": null, + "refs": { + "AccessDeniedException$Message": null, + "ConflictException$Message": null, + "ConflictException$ResourceId": "The resource's ID.
", + "ConflictException$ResourceType": "The resource's type.
", + "ConflictException$ErrorId": "A unique ID for the error.
", + "ConflictExceptionErrorArgument$Name": "The error argument's name.
", + "ConflictExceptionErrorArgument$Value": "The error argument's value.
", + "InternalServerException$Message": null, + "ResourceNotFoundException$Message": null, + "ResourceNotFoundException$ResourceId": "The resource's ID.
", + "ResourceNotFoundException$ResourceType": "The resource's type.
", + "ServiceQuotaExceededException$Message": null, + "ServiceQuotaExceededException$ResourceId": "The target resource's ID.
", + "ServiceQuotaExceededException$ResourceType": "The target resource's type.
", + "ServiceQuotaExceededException$QuotaCode": "The name of the limit.
", + "ServiceQuotaExceededException$ServiceCode": "The name of the service.
", + "ValidationException$Message": null, + "ValidationException$ErrorId": "A unique ID for the error.
", + "ValidationExceptionErrorArgument$Name": "The argument's name.
", + "ValidationExceptionErrorArgument$Value": "The argument's value.
", + "ValidationExceptionField$Name": "The field's name.
", + "ValidationExceptionField$Message": "The field's message.
" + } + }, + "TagKey": { + "base": null, + "refs": { + "TagKeyList$member": null, + "TagMap$key": null + } + }, + "TagKeyList": { + "base": null, + "refs": { + "UntagResourceRequest$TagKeys": "Tag keys to remove.
" + } + }, + "TagMap": { + "base": null, + "refs": { + "ApplicationInstance$Tags": "The application instance's tags.
", + "CreateApplicationInstanceRequest$Tags": "Tags for the application instance.
", + "CreatePackageRequest$Tags": "Tags for the package.
", + "DescribeApplicationInstanceResponse$Tags": "The application instance's tags.
", + "DescribeDeviceResponse$Tags": "The device's tags.
", + "DescribePackageResponse$Tags": "The package's tags.
", + "JobResourceTags$Tags": "The job's tags.
", + "ListTagsForResourceResponse$Tags": "A list of tags.
", + "PackageListItem$Tags": "The package's tags.
", + "ProvisionDeviceRequest$Tags": "Tags for the device.
", + "TagResourceRequest$Tags": "Tags for the resource.
" + } + }, + "TagResourceRequest": { + "base": null, + "refs": { + } + }, + "TagResourceResponse": { + "base": null, + "refs": { + } + }, + "TagValue": { + "base": null, + "refs": { + "TagMap$value": null + } + }, + "TemplateKey": { + "base": null, + "refs": { + "TemplateParametersMap$key": null + } + }, + "TemplateParametersMap": { + "base": null, + "refs": { + "CreateNodeFromTemplateJobRequest$TemplateParameters": "Template parameters for the node.
", + "DescribeNodeFromTemplateJobResponse$TemplateParameters": "The job's template parameters.
" + } + }, + "TemplateType": { + "base": null, + "refs": { + "CreateNodeFromTemplateJobRequest$TemplateType": "The type of node.
", + "DescribeNodeFromTemplateJobResponse$TemplateType": "The job's template type.
", + "NodeFromTemplateJob$TemplateType": "The job's template type.
" + } + }, + "TemplateValue": { + "base": null, + "refs": { + "TemplateParametersMap$value": null + } + }, + "TimeStamp": { + "base": null, + "refs": { + "ApplicationInstance$CreatedTime": "When the application instance was created.
", + "DescribeApplicationInstanceDetailsResponse$CreatedTime": "When the application instance was created.
", + "DescribeApplicationInstanceResponse$CreatedTime": "When the application instance was created.
", + "DescribeApplicationInstanceResponse$LastUpdatedTime": "The application instance was updated.
", + "DescribeNodeResponse$CreatedTime": "When the node was created.
", + "DescribeNodeResponse$LastUpdatedTime": "When the node was updated.
", + "DescribePackageResponse$CreatedTime": "When the package was created.
", + "DescribePackageVersionResponse$RegisteredTime": "The version's registered time.
", + "Node$CreatedTime": "When the node was created.
", + "PackageListItem$CreatedTime": "When the package was created.
" + } + }, + "Token": { + "base": null, + "refs": { + "ListNodesRequest$NextToken": "Specify the pagination token from a previous request to retrieve the next page of results.
", + "ListNodesResponse$NextToken": "A pagination token that's included if more results are available.
", + "ListPackagesRequest$NextToken": "Specify the pagination token from a previous request to retrieve the next page of results.
" + } + }, + "UntagResourceRequest": { + "base": null, + "refs": { + } + }, + "UntagResourceResponse": { + "base": null, + "refs": { + } + }, + "UpdateCreatedTime": { + "base": null, + "refs": { + "DescribeDeviceJobResponse$CreatedTime": "When the job was created.
" + } + }, + "UpdateDeviceMetadataRequest": { + "base": null, + "refs": { + } + }, + "UpdateDeviceMetadataResponse": { + "base": null, + "refs": { + } + }, + "UpdateProgress": { + "base": null, + "refs": { + "DescribeDeviceJobResponse$Status": "The job's status.
" + } + }, + "ValidationException": { + "base": "The request contains an invalid parameter value.
", + "refs": { + } + }, + "ValidationExceptionErrorArgument": { + "base": "A validation exception error argument.
", + "refs": { + "ValidationExceptionErrorArgumentList$member": null + } + }, + "ValidationExceptionErrorArgumentList": { + "base": null, + "refs": { + "ValidationException$ErrorArguments": "A list of attributes that led to the exception and their values.
" + } + }, + "ValidationExceptionField": { + "base": "A validation exception field.
", + "refs": { + "ValidationExceptionFieldList$member": null + } + }, + "ValidationExceptionFieldList": { + "base": null, + "refs": { + "ValidationException$Fields": "A list of request parameters that failed validation.
" + } + }, + "ValidationExceptionReason": { + "base": null, + "refs": { + "ValidationException$Reason": "The reason that validation failed.
" + } + } + } +} diff --git a/models/apis/panorama/2019-07-24/examples-1.json b/models/apis/panorama/2019-07-24/examples-1.json new file mode 100644 index 0000000000..0ea7e3b0bb --- /dev/null +++ b/models/apis/panorama/2019-07-24/examples-1.json @@ -0,0 +1,5 @@ +{ + "version": "1.0", + "examples": { + } +} diff --git a/models/apis/panorama/2019-07-24/paginators-1.json b/models/apis/panorama/2019-07-24/paginators-1.json new file mode 100644 index 0000000000..6958fd2623 --- /dev/null +++ b/models/apis/panorama/2019-07-24/paginators-1.json @@ -0,0 +1,49 @@ +{ + "pagination": { + "ListApplicationInstanceDependencies": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "MaxResults" + }, + "ListApplicationInstanceNodeInstances": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "MaxResults" + }, + "ListApplicationInstances": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "MaxResults" + }, + "ListDevices": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "MaxResults" + }, + "ListDevicesJobs": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "MaxResults" + }, + "ListNodeFromTemplateJobs": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "MaxResults" + }, + "ListNodes": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "MaxResults" + }, + "ListPackageImportJobs": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "MaxResults" + }, + "ListPackages": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "MaxResults" + } + } +} diff --git a/models/apis/securityhub/2018-10-26/api-2.json b/models/apis/securityhub/2018-10-26/api-2.json index b279ecba6a..9e80afe379 100644 --- a/models/apis/securityhub/2018-10-26/api-2.json +++ b/models/apis/securityhub/2018-10-26/api-2.json @@ -122,6 +122,22 @@ {"shape":"ResourceConflictException"} ] }, + "CreateFindingAggregator":{ + "name":"CreateFindingAggregator", + "http":{ + "method":"POST", + "requestUri":"/findingAggregator/create" + }, + "input":{"shape":"CreateFindingAggregatorRequest"}, + "output":{"shape":"CreateFindingAggregatorResponse"}, + "errors":[ + {"shape":"InternalException"}, + {"shape":"LimitExceededException"}, + {"shape":"InvalidAccessException"}, + {"shape":"AccessDeniedException"}, + {"shape":"InvalidInputException"} + ] + }, "CreateInsight":{ "name":"CreateInsight", "http":{ @@ -184,6 +200,23 @@ {"shape":"ResourceNotFoundException"} ] }, + "DeleteFindingAggregator":{ + "name":"DeleteFindingAggregator", + "http":{ + "method":"DELETE", + "requestUri":"/findingAggregator/delete/{FindingAggregatorArn+}" + }, + "input":{"shape":"DeleteFindingAggregatorRequest"}, + "output":{"shape":"DeleteFindingAggregatorResponse"}, + "errors":[ + {"shape":"InternalException"}, + {"shape":"LimitExceededException"}, + {"shape":"InvalidAccessException"}, + {"shape":"AccessDeniedException"}, + {"shape":"InvalidInputException"}, + {"shape":"ResourceNotFoundException"} + ] + }, "DeleteInsight":{ "name":"DeleteInsight", "http":{ @@ -496,6 +529,23 @@ {"shape":"LimitExceededException"} ] }, + "GetFindingAggregator":{ + "name":"GetFindingAggregator", + "http":{ + "method":"GET", + "requestUri":"/findingAggregator/get/{FindingAggregatorArn+}" + }, + "input":{"shape":"GetFindingAggregatorRequest"}, + "output":{"shape":"GetFindingAggregatorResponse"}, + "errors":[ + {"shape":"InternalException"}, + {"shape":"LimitExceededException"}, + {"shape":"InvalidAccessException"}, + {"shape":"AccessDeniedException"}, + {"shape":"InvalidInputException"}, + {"shape":"ResourceNotFoundException"} + ] + }, "GetFindings":{ "name":"GetFindings", "http":{ @@ -622,6 +672,22 @@ {"shape":"InvalidAccessException"} ] }, + "ListFindingAggregators":{ + "name":"ListFindingAggregators", + "http":{ + "method":"GET", + "requestUri":"/findingAggregator/list" + }, + "input":{"shape":"ListFindingAggregatorsRequest"}, + "output":{"shape":"ListFindingAggregatorsResponse"}, + "errors":[ + {"shape":"InternalException"}, + {"shape":"LimitExceededException"}, + {"shape":"InvalidAccessException"}, + {"shape":"AccessDeniedException"}, + {"shape":"InvalidInputException"} + ] + }, "ListInvitations":{ "name":"ListInvitations", "http":{ @@ -725,6 +791,23 @@ {"shape":"ResourceNotFoundException"} ] }, + "UpdateFindingAggregator":{ + "name":"UpdateFindingAggregator", + "http":{ + "method":"PATCH", + "requestUri":"/findingAggregator/update" + }, + "input":{"shape":"UpdateFindingAggregatorRequest"}, + "output":{"shape":"UpdateFindingAggregatorResponse"}, + "errors":[ + {"shape":"InternalException"}, + {"shape":"LimitExceededException"}, + {"shape":"InvalidAccessException"}, + {"shape":"AccessDeniedException"}, + {"shape":"InvalidInputException"}, + {"shape":"ResourceNotFoundException"} + ] + }, "UpdateFindings":{ "name":"UpdateFindings", "http":{ @@ -4727,6 +4810,23 @@ "ActionTargetArn":{"shape":"NonEmptyString"} } }, + "CreateFindingAggregatorRequest":{ + "type":"structure", + "required":["RegionLinkingMode"], + "members":{ + "RegionLinkingMode":{"shape":"NonEmptyString"}, + "Regions":{"shape":"StringList"} + } + }, + "CreateFindingAggregatorResponse":{ + "type":"structure", + "members":{ + "FindingAggregatorArn":{"shape":"NonEmptyString"}, + "FindingAggregationRegion":{"shape":"NonEmptyString"}, + "RegionLinkingMode":{"shape":"NonEmptyString"}, + "Regions":{"shape":"StringList"} + } + }, "CreateInsightRequest":{ "type":"structure", "required":[ @@ -4860,6 +4960,22 @@ "ActionTargetArn":{"shape":"NonEmptyString"} } }, + "DeleteFindingAggregatorRequest":{ + "type":"structure", + "required":["FindingAggregatorArn"], + "members":{ + "FindingAggregatorArn":{ + "shape":"NonEmptyString", + "location":"uri", + "locationName":"FindingAggregatorArn" + } + } + }, + "DeleteFindingAggregatorResponse":{ + "type":"structure", + "members":{ + } + }, "DeleteInsightRequest":{ "type":"structure", "required":["InsightArn"], @@ -5149,6 +5265,16 @@ "key":{"shape":"NonEmptyString"}, "value":{"shape":"NonEmptyString"} }, + "FindingAggregator":{ + "type":"structure", + "members":{ + "FindingAggregatorArn":{"shape":"NonEmptyString"} + } + }, + "FindingAggregatorList":{ + "type":"list", + "member":{"shape":"FindingAggregator"} + }, "FindingProviderFields":{ "type":"structure", "members":{ @@ -5199,6 +5325,26 @@ "NextToken":{"shape":"NextToken"} } }, + "GetFindingAggregatorRequest":{ + "type":"structure", + "required":["FindingAggregatorArn"], + "members":{ + "FindingAggregatorArn":{ + "shape":"NonEmptyString", + "location":"uri", + "locationName":"FindingAggregatorArn" + } + } + }, + "GetFindingAggregatorResponse":{ + "type":"structure", + "members":{ + "FindingAggregatorArn":{"shape":"NonEmptyString"}, + "FindingAggregationRegion":{"shape":"NonEmptyString"}, + "RegionLinkingMode":{"shape":"NonEmptyString"}, + "Regions":{"shape":"StringList"} + } + }, "GetFindingsRequest":{ "type":"structure", "members":{ @@ -5499,6 +5645,28 @@ "NextToken":{"shape":"NextToken"} } }, + "ListFindingAggregatorsRequest":{ + "type":"structure", + "members":{ + "NextToken":{ + "shape":"NextToken", + "location":"querystring", + "locationName":"NextToken" + }, + "MaxResults":{ + "shape":"MaxResults", + "location":"querystring", + "locationName":"MaxResults" + } + } + }, + "ListFindingAggregatorsResponse":{ + "type":"structure", + "members":{ + "FindingAggregators":{"shape":"FindingAggregatorList"}, + "NextToken":{"shape":"NextToken"} + } + }, "ListInvitationsRequest":{ "type":"structure", "members":{ @@ -6448,6 +6616,27 @@ "members":{ } }, + "UpdateFindingAggregatorRequest":{ + "type":"structure", + "required":[ + "FindingAggregatorArn", + "RegionLinkingMode" + ], + "members":{ + "FindingAggregatorArn":{"shape":"NonEmptyString"}, + "RegionLinkingMode":{"shape":"NonEmptyString"}, + "Regions":{"shape":"StringList"} + } + }, + "UpdateFindingAggregatorResponse":{ + "type":"structure", + "members":{ + "FindingAggregatorArn":{"shape":"NonEmptyString"}, + "FindingAggregationRegion":{"shape":"NonEmptyString"}, + "RegionLinkingMode":{"shape":"NonEmptyString"}, + "Regions":{"shape":"StringList"} + } + }, "UpdateFindingsRequest":{ "type":"structure", "required":["Filters"], diff --git a/models/apis/securityhub/2018-10-26/docs-2.json b/models/apis/securityhub/2018-10-26/docs-2.json index 16a8c71a30..ad56153eaf 100644 --- a/models/apis/securityhub/2018-10-26/docs-2.json +++ b/models/apis/securityhub/2018-10-26/docs-2.json @@ -9,10 +9,12 @@ "BatchImportFindings": "Imports security findings generated from an integrated product into Security Hub. This action is requested by the integrated product to import its findings into Security Hub.
The maximum allowed size for a finding is 240 Kb. An error is returned for any finding larger than 240 Kb.
After a finding is created, BatchImportFindings cannot be used to update the following finding fields and objects, which Security Hub customers use to manage their investigation workflow.
Note
UserDefinedFields
VerificationState
Workflow
Finding providers also should not use BatchImportFindings to update the following attributes.
Confidence
Criticality
RelatedFindings
Severity
Types
Instead, finding providers use FindingProviderFields to provide values for these attributes.
Used by Security Hub customers to update information about their investigation into a finding. Requested by administrator accounts or member accounts. Administrator accounts can update findings for their account and their member accounts. Member accounts can update findings for their account.
Updates from BatchUpdateFindings do not affect the value of UpdatedAt for a finding.
Administrator and member accounts can use BatchUpdateFindings to update the following finding fields and objects.
Confidence
Criticality
Note
RelatedFindings
Severity
Types
UserDefinedFields
VerificationState
Workflow
You can configure IAM policies to restrict access to fields and field values. For example, you might not want member accounts to be able to suppress findings or change the finding severity. See Configuring access to BatchUpdateFindings in the Security Hub User Guide.
", "CreateActionTarget": "Creates a custom action target in Security Hub.
You can use custom actions on findings and insights in Security Hub to trigger target actions in Amazon CloudWatch Events.
", + "CreateFindingAggregator": "Used to enable finding aggregation. Must be called from the aggregation Region.
For more details about cross-Region replication, see Configuring finding aggregation in the Security Hub User Guide.
", "CreateInsight": "Creates a custom insight in Security Hub. An insight is a consolidation of findings that relate to a security issue that requires attention or remediation.
To group the related findings in the insight, use the GroupByAttribute.
Creates a member association in Security Hub between the specified accounts and the account used to make the request, which is the administrator account. If you are integrated with Organizations, then the administrator account is designated by the organization management account.
CreateMembers is always used to add accounts that are not organization members.
For accounts that are managed using Organizations, CreateMembers is only used in the following cases:
Security Hub is not configured to automatically add new organization accounts.
The account was disassociated or deleted in Security Hub.
This action can only be used by an account that has Security Hub enabled. To enable Security Hub, you can use the EnableSecurityHub operation.
For accounts that are not organization members, you create the account association and then send an invitation to the member account. To send the invitation, you use the InviteMembers operation. If the account owner accepts the invitation, the account becomes a member account in Security Hub.
Accounts that are managed using Organizations do not receive an invitation. They automatically become a member account in Security Hub.
If the organization account does not have Security Hub enabled, then Security Hub and the default standards are automatically enabled. Note that Security Hub cannot be enabled automatically for the organization management account. The organization management account must enable Security Hub before the administrator account enables it as a member account.
For organization accounts that already have Security Hub enabled, Security Hub does not make any other changes to those accounts. It does not change their enabled standards or controls.
A permissions policy is added that permits the administrator account to view the findings generated in the member account.
To remove the association between the administrator and member accounts, use the DisassociateFromMasterAccount or DisassociateMembers operation.
Declines invitations to become a member account.
This operation is only used by accounts that are not part of an organization. Organization accounts do not receive invitations.
", "DeleteActionTarget": "Deletes a custom action target from Security Hub.
Deleting a custom action target does not affect any findings or insights that were already sent to Amazon CloudWatch Events using the custom action.
", + "DeleteFindingAggregator": "Deletes a finding aggregator. When you delete the finding aggregator, you stop finding aggregation.
When you stop finding aggregation, findings that were already aggregated to the aggregation Region are still visible from the aggregation Region. New findings and finding updates are not aggregated.
", "DeleteInsight": "Deletes the insight specified by the InsightArn.
Deletes invitations received by the Amazon Web Services account to become a member account.
This operation is only used by accounts that are not part of an organization. Organization accounts do not receive invitations.
", "DeleteMembers": "Deletes the specified member accounts from Security Hub.
Can be used to delete member accounts that belong to an organization as well as member accounts that were invited manually.
", @@ -33,7 +35,8 @@ "EnableSecurityHub": "Enables Security Hub for your account in the current Region or the Region you specify in the request.
When you enable Security Hub, you grant to Security Hub the permissions necessary to gather findings from other services that are integrated with Security Hub.
When you use the EnableSecurityHub operation to enable Security Hub, you also automatically enable the following standards.
CIS Amazon Web Services Foundations
Amazon Web Services Foundational Security Best Practices
You do not enable the Payment Card Industry Data Security Standard (PCI DSS) standard.
To not enable the automatically enabled standards, set EnableDefaultStandards to false.
After you enable Security Hub, to enable a standard, use the BatchEnableStandards operation. To disable a standard, use the BatchDisableStandards operation.
To learn more, see the setup information in the Security Hub User Guide.
", "GetAdministratorAccount": "Provides the details for the Security Hub administrator account for the current member account.
Can be used by both member accounts that are managed using Organizations and accounts that were invited manually.
", "GetEnabledStandards": "Returns a list of the standards that are currently enabled.
", - "GetFindings": "Returns a list of findings that match the specified criteria.
", + "GetFindingAggregator": "Returns the current finding aggregation configuration.
", + "GetFindings": "Returns a list of findings that match the specified criteria.
If finding aggregation is enabled, then when you call GetFindings from the aggregation Region, the results include all of the matching findings from both the aggregation Region and the linked Regions.
Lists the results of the Security Hub insight specified by the insight ARN.
", "GetInsights": "Lists and describes insights for the specified insight ARNs.
", "GetInvitationsCount": "Returns the count of all Security Hub membership invitations that were sent to the current member account, not including the currently accepted invitation.
", @@ -41,6 +44,7 @@ "GetMembers": "Returns the details for the Security Hub member accounts for the specified account IDs.
An administrator account can be either the delegated Security Hub administrator account for an organization or an administrator account that enabled Security Hub manually.
The results include both member accounts that are managed using Organizations and accounts that were invited manually.
", "InviteMembers": "Invites other Amazon Web Services accounts to become member accounts for the Security Hub administrator account that the invitation is sent from.
This operation is only used to invite accounts that do not belong to an organization. Organization accounts do not receive invitations.
Before you can use this action to invite a member, you must first use the CreateMembers action to create the member account in Security Hub.
When the account owner enables Security Hub and accepts the invitation to become a member account, the administrator account can view the findings generated from the member account.
", "ListEnabledProductsForImport": "Lists all findings-generating solutions (products) that you are subscribed to receive findings from in Security Hub.
", + "ListFindingAggregators": "If finding aggregation is enabled, then ListFindingAggregators returns the ARN of the finding aggregator. You can run this operation from any Region.
Lists all Security Hub membership invitations that were sent to the current Amazon Web Services account.
This operation is only used by accounts that are managed by invitation. Accounts that are managed using the integration with Organizations do not receive invitations.
", "ListMembers": "Lists details about all member accounts for the current Security Hub administrator account.
The results include both member accounts that belong to an organization and member accounts that were invited manually.
", "ListOrganizationAdminAccounts": "Lists the Security Hub administrator accounts. Can only be called by the organization management account.
", @@ -48,6 +52,7 @@ "TagResource": "Adds one or more tags to a resource.
", "UntagResource": "Removes one or more tags from a resource.
", "UpdateActionTarget": "Updates the name and description of a custom action target in Security Hub.
", + "UpdateFindingAggregator": "Updates the finding aggregation configuration. Used to update the Region linking mode and the list of included or excluded Regions. You cannot use UpdateFindingAggregator to change the aggregation Region.
You must run UpdateFindingAggregator from the current aggregation Region.
UpdateFindings is deprecated. Instead of UpdateFindings, use BatchUpdateFindings.
Updates the Note and RecordState of the Security Hub-aggregated findings that the filter attributes specify. Any member account that can view the finding also sees the update to the finding.
Updates the Security Hub insight identified by the specified insight ARN.
", "UpdateOrganizationConfiguration": "Used to update the configuration related to Organizations. Can only be called from a Security Hub administrator account.
", @@ -2979,6 +2984,16 @@ "refs": { } }, + "CreateFindingAggregatorRequest": { + "base": null, + "refs": { + } + }, + "CreateFindingAggregatorResponse": { + "base": null, + "refs": { + } + }, "CreateInsightRequest": { "base": null, "refs": { @@ -3096,6 +3111,16 @@ "refs": { } }, + "DeleteFindingAggregatorRequest": { + "base": null, + "refs": { + } + }, + "DeleteFindingAggregatorResponse": { + "base": null, + "refs": { + } + }, "DeleteInsightRequest": { "base": null, "refs": { @@ -3322,6 +3347,18 @@ "ResourceDetails$Other": "Details about a resource that are not available in a type-specific details object. Use the Other object in the following cases.
The type-specific object does not contain all of the fields that you want to populate. In this case, first use the type-specific object to populate those fields. Use the Other object to populate the fields that are missing from the type-specific object.
The resource type does not have a corresponding object. This includes resources for which the type is Other.
A finding aggregator. A finding aggregator contains the configuration for finding aggregation.
", + "refs": { + "FindingAggregatorList$member": null + } + }, + "FindingAggregatorList": { + "base": null, + "refs": { + "ListFindingAggregatorsResponse$FindingAggregators": "The list of finding aggregators. This operation currently only returns a single result.
" + } + }, "FindingProviderFields": { "base": "In a BatchImportFindings request, finding providers use FindingProviderFields to provide and update values for confidence, criticality, related findings, severity, and types.
The maximum number of results to return in the response.
", "GetFindingsRequest$MaxResults": "The maximum number of findings to return.
", "GetInsightsRequest$MaxResults": "The maximum number of items to return in the response.
", - "ListEnabledProductsForImportRequest$MaxResults": "The maximum number of items to return in the response.
" + "ListEnabledProductsForImportRequest$MaxResults": "The maximum number of items to return in the response.
", + "ListFindingAggregatorsRequest$MaxResults": "The maximum number of results to return. This operation currently only returns a single result.
" } }, "Member": { @@ -3960,6 +4018,8 @@ "GetInsightsResponse$NextToken": "The pagination token to use to request the next page of results.
", "ListEnabledProductsForImportRequest$NextToken": "The token that is required for pagination. On your first call to the ListEnabledProductsForImport operation, set the value of this parameter to NULL.
For subsequent calls to the operation, to continue listing data, set the value of this parameter to the value returned from the previous response.
", "ListEnabledProductsForImportResponse$NextToken": "The pagination token to use to request the next page of results.
", + "ListFindingAggregatorsRequest$NextToken": "The token returned with the previous set of results. Identifies the next set of results to return.
", + "ListFindingAggregatorsResponse$NextToken": "If there are more results, this is the token to provide in the next call to ListFindingAggregators.
This operation currently only returns a single result.
", "ListInvitationsRequest$NextToken": "The token that is required for pagination. On your first call to the ListInvitations operation, set the value of this parameter to NULL.
For subsequent calls to the operation, to continue listing data, set the value of this parameter to the value returned from the previous response.
", "ListMembersRequest$NextToken": "The token that is required for pagination. On your first call to the ListMembers operation, set the value of this parameter to NULL.
For subsequent calls to the operation, to continue listing data, set the value of this parameter to the value returned from the previous response.
", "ListOrganizationAdminAccountsRequest$NextToken": "The token that is required for pagination. On your first call to the ListOrganizationAdminAccounts operation, set the value of this parameter to NULL. For subsequent calls to the operation, to continue listing data, set the value of this parameter to the value returned from the previous response.
The description for the custom action target.
", "CreateActionTargetRequest$Id": "The ID for the custom action target. Can contain up to 20 alphanumeric characters.
", "CreateActionTargetResponse$ActionTargetArn": "The ARN for the custom action target.
", + "CreateFindingAggregatorRequest$RegionLinkingMode": "Indicates whether to aggregate findings from all of the available Regions in the current partition. Also determines whether to automatically aggregate findings from new Regions as Security Hub supports them and you opt into them.
The selected option also determines how to use the Regions provided in the Regions list.
The options are as follows:
ALL_REGIONS - Indicates to aggregate findings from all of the Regions where Security Hub is enabled. When you choose this option, Security Hub also automatically aggregates findings from new Regions as Security Hub supports them and you opt into them.
ALL_REGIONS_EXCEPT_SPECIFIED - Indicates to aggregate findings from all of the Regions where Security Hub is enabled, except for the Regions listed in the Regions parameter. When you choose this option, Security Hub also automatically aggregates findings from new Regions as Security Hub supports them and you opt into them.
SPECIFIED_REGIONS - Indicates to aggregate findings only from the Regions listed in the Regions parameter. Security Hub does not automatically aggregate findings from new Regions.
The ARN of the finding aggregator. You use the finding aggregator ARN to retrieve details for, update, and stop finding aggregation.
", + "CreateFindingAggregatorResponse$FindingAggregationRegion": "The aggregation Region.
", + "CreateFindingAggregatorResponse$RegionLinkingMode": "Indicates whether to link all Regions, all Regions except for a list of excluded Regions, or a list of included Regions.
", "CreateInsightRequest$Name": "The name of the custom insight to create.
", "CreateInsightRequest$GroupByAttribute": "The attribute used to group the findings for the insight. The grouping attribute identifies the type of item that the insight applies to. For example, if an insight is grouped by resource identifier, then the insight produces a list of resource identifiers.
", "CreateInsightResponse$InsightArn": "The ARN of the insight created.
", @@ -4855,6 +4919,7 @@ "DateFilter$End": "An end date for the date filter.
", "DeleteActionTargetRequest$ActionTargetArn": "The ARN of the custom action target to delete.
", "DeleteActionTargetResponse$ActionTargetArn": "The ARN of the custom action target that was deleted.
", + "DeleteFindingAggregatorRequest$FindingAggregatorArn": "The ARN of the finding aggregator to delete. To obtain the ARN, use ListFindingAggregators.
The ARN of the insight to delete.
", "DeleteInsightResponse$InsightArn": "The ARN of the insight that was deleted.
", "DescribeHubRequest$HubArn": "The ARN of the Hub resource to retrieve.
", @@ -4871,7 +4936,12 @@ "EnableOrganizationAdminAccountRequest$AdminAccountId": "The Amazon Web Services account identifier of the account to designate as the Security Hub administrator account.
", "FieldMap$key": null, "FieldMap$value": null, + "FindingAggregator$FindingAggregatorArn": "The ARN of the finding aggregator. You use the finding aggregator ARN to retrieve details for, update, and delete the finding aggregator.
", "FindingProviderSeverity$Original": "The finding provider's original value for the severity.
", + "GetFindingAggregatorRequest$FindingAggregatorArn": "The ARN of the finding aggregator to return details for. To obtain the ARN, use ListFindingAggregators.
The ARN of the finding aggregator.
", + "GetFindingAggregatorResponse$FindingAggregationRegion": "The aggregation Region.
", + "GetFindingAggregatorResponse$RegionLinkingMode": "Indicates whether to link all Regions, all Regions except for a list of excluded Regions, or a list of included Regions.
", "GetInsightResultsRequest$InsightArn": "The ARN of the insight for which to return results.
", "ImportFindingsError$Id": "The identifier of the finding that could not be updated.
", "ImportFindingsError$ErrorCode": "The code of the error returned by the BatchImportFindings operation.
The ARN of the custom action target to update.
", "UpdateActionTargetRequest$Name": "The updated name of the custom action target.
", "UpdateActionTargetRequest$Description": "The updated description for the custom action target.
", + "UpdateFindingAggregatorRequest$FindingAggregatorArn": "The ARN of the finding aggregator. To obtain the ARN, use ListFindingAggregators.
Indicates whether to aggregate findings from all of the available Regions in the current partition. Also determines whether to automatically aggregate findings from new Regions as Security Hub supports them and you opt into them.
The selected option also determines how to use the Regions provided in the Regions list.
The options are as follows:
ALL_REGIONS - Indicates to aggregate findings from all of the Regions where Security Hub is enabled. When you choose this option, Security Hub also automatically aggregates findings from new Regions as Security Hub supports them and you opt into them.
ALL_REGIONS_EXCEPT_SPECIFIED - Indicates to aggregate findings from all of the Regions where Security Hub is enabled, except for the Regions listed in the Regions parameter. When you choose this option, Security Hub also automatically aggregates findings from new Regions as Security Hub supports them and you opt into them.
SPECIFIED_REGIONS - Indicates to aggregate findings only from the Regions listed in the Regions parameter. Security Hub does not automatically aggregate findings from new Regions.
The ARN of the finding aggregator.
", + "UpdateFindingAggregatorResponse$FindingAggregationRegion": "The aggregation Region.
", + "UpdateFindingAggregatorResponse$RegionLinkingMode": "Indicates whether to link all Regions, all Regions except for a list of excluded Regions, or a list of included Regions.
", "UpdateInsightRequest$InsightArn": "The ARN of the insight that you want to update.
", "UpdateInsightRequest$Name": "The updated name for the insight.
", "UpdateInsightRequest$GroupByAttribute": "The updated GroupBy attribute that defines this insight.
A list of log types that are being enabled.
", "AwsRdsPendingCloudWatchLogsExports$LogTypesToDisable": "A list of log types that are being disabled.
", "AwsRedshiftClusterDetails$PendingActions": "A list of cluster operations that are waiting to start.
", + "CreateFindingAggregatorRequest$Regions": "If RegionLinkingMode is ALL_REGIONS_EXCEPT_SPECIFIED, then this is a comma-separated list of Regions that do not aggregate findings to the aggregation Region.
If RegionLinkingMode is SPECIFIED_REGIONS, then this is a comma-separated list of Regions that do aggregate findings to the aggregation Region.
The list of excluded Regions or included Regions.
", + "GetFindingAggregatorResponse$Regions": "The list of excluded Regions or included Regions.
", "NetworkPathComponentDetails$Address": "The IP addresses of the destination.
", + "UpdateFindingAggregatorRequest$Regions": "If RegionLinkingMode is ALL_REGIONS_EXCEPT_SPECIFIED, then this is a comma-separated list of Regions that do not aggregate findings to the aggregation Region.
If RegionLinkingMode is SPECIFIED_REGIONS, then this is a comma-separated list of Regions that do aggregate findings to the aggregation Region.
The list of excluded Regions or included Regions.
", "Vulnerability$RelatedVulnerabilities": "List of vulnerabilities that are related to this vulnerability.
", "Vulnerability$ReferenceUrls": "A list of URLs that provide additional information about the vulnerability.
" } @@ -5713,6 +5793,16 @@ "refs": { } }, + "UpdateFindingAggregatorRequest": { + "base": null, + "refs": { + } + }, + "UpdateFindingAggregatorResponse": { + "base": null, + "refs": { + } + }, "UpdateFindingsRequest": { "base": null, "refs": { diff --git a/models/apis/securityhub/2018-10-26/paginators-1.json b/models/apis/securityhub/2018-10-26/paginators-1.json index b9bcc010dd..85871fc350 100644 --- a/models/apis/securityhub/2018-10-26/paginators-1.json +++ b/models/apis/securityhub/2018-10-26/paginators-1.json @@ -48,6 +48,12 @@ "limit_key": "MaxResults", "result_key": "ProductSubscriptions" }, + "ListFindingAggregators": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "MaxResults", + "result_key": "FindingAggregators" + }, "ListInvitations": { "input_token": "NextToken", "output_token": "NextToken", diff --git a/models/apis/transcribe-streaming/2017-10-26/api-2.json b/models/apis/transcribe-streaming/2017-10-26/api-2.json index 0d19b80a91..b0c938f5fe 100755 --- a/models/apis/transcribe-streaming/2017-10-26/api-2.json +++ b/models/apis/transcribe-streaming/2017-10-26/api-2.json @@ -274,6 +274,12 @@ }, "eventstream":true }, + "ModelName":{ + "type":"string", + "max":200, + "min":1, + "pattern":"^[0-9a-zA-Z._-]+" + }, "NumberOfChannels":{ "type":"integer", "min":2 @@ -555,6 +561,11 @@ "shape":"PiiEntityTypes", "location":"header", "locationName":"x-amzn-transcribe-pii-entity-types" + }, + "LanguageModelName":{ + "shape":"ModelName", + "location":"header", + "locationName":"x-amzn-transcribe-language-model-name" } }, "payload":"AudioStream" @@ -642,6 +653,11 @@ "shape":"PiiEntityTypes", "location":"header", "locationName":"x-amzn-transcribe-pii-entity-types" + }, + "LanguageModelName":{ + "shape":"ModelName", + "location":"header", + "locationName":"x-amzn-transcribe-language-model-name" } }, "payload":"TranscriptResultStream" diff --git a/models/apis/transcribe-streaming/2017-10-26/docs-2.json b/models/apis/transcribe-streaming/2017-10-26/docs-2.json index cebd66ddd2..648a162dfe 100755 --- a/models/apis/transcribe-streaming/2017-10-26/docs-2.json +++ b/models/apis/transcribe-streaming/2017-10-26/docs-2.json @@ -254,6 +254,13 @@ "StartMedicalStreamTranscriptionResponse$TranscriptResultStream": "Represents the stream of transcription events from Amazon Transcribe Medical to your application.
" } }, + "ModelName": { + "base": null, + "refs": { + "StartStreamTranscriptionRequest$LanguageModelName": "The name of the language model you want to use.
", + "StartStreamTranscriptionResponse$LanguageModelName": null + } + }, "NumberOfChannels": { "base": null, "refs": { @@ -273,7 +280,7 @@ "PiiEntityTypes": { "base": null, "refs": { - "StartStreamTranscriptionRequest$PiiEntityTypes": "List the PII entity types you want to identify or redact. In order to specify entity types, you must have either ContentIdentificationType or ContentRedactionType enabled.
PIIEntityTypes must be comma-separated; the available values are: BANK_ACCOUNT_NUMBER, BANK_ROUTING, CREDIT_DEBIT_NUMBER, CREDIT_DEBIT_CVV, CREDIT_DEBIT_EXPIRY, PIN, EMAIL, ADDRESS, NAME, PHONE, SSN, and ALL.
PiiEntityTypes is an optional parameter with a default value of ALL.
List the PII entity types you want to identify or redact. In order to specify entity types, you must have either ContentIdentificationType or ContentRedactionType enabled.
PiiEntityTypes is an optional parameter with a default value of ALL.
Lists the PII entity types you specified in your request.
" } }, diff --git a/service/appflow/api.go b/service/appflow/api.go index 93c5e1a231..6162b9daaa 100644 --- a/service/appflow/api.go +++ b/service/appflow/api.go @@ -8021,6 +8021,39 @@ func (s *S3DestinationProperties) SetS3OutputFormatConfig(v *S3OutputFormatConfi return s } +// When you use Amazon S3 as the source, the configuration format that you provide +// the flow input data. +type S3InputFormatConfig struct { + _ struct{} `type:"structure"` + + // The file type that Amazon AppFlow gets from your Amazon S3 bucket. + S3InputFileType *string `locationName:"s3InputFileType" type:"string" enum:"S3InputFileType"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s S3InputFormatConfig) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s S3InputFormatConfig) GoString() string { + return s.String() +} + +// SetS3InputFileType sets the S3InputFileType field's value. +func (s *S3InputFormatConfig) SetS3InputFileType(v string) *S3InputFormatConfig { + s.S3InputFileType = &v + return s +} + // The connector metadata specific to Amazon S3. type S3Metadata struct { _ struct{} `type:"structure"` @@ -8110,6 +8143,10 @@ type S3SourceProperties struct { // The object key for the Amazon S3 bucket in which the source files are stored. BucketPrefix *string `locationName:"bucketPrefix" type:"string"` + + // When you use Amazon S3 as the source, the configuration format that you provide + // the flow input data. + S3InputFormatConfig *S3InputFormatConfig `locationName:"s3InputFormatConfig" type:"structure"` } // String returns the string representation. @@ -8158,6 +8195,12 @@ func (s *S3SourceProperties) SetBucketPrefix(v string) *S3SourceProperties { return s } +// SetS3InputFormatConfig sets the S3InputFormatConfig field's value. +func (s *S3SourceProperties) SetS3InputFormatConfig(v *S3InputFormatConfig) *S3SourceProperties { + s.S3InputFormatConfig = v + return s +} + // The connector-specific profile credentials required when using SAPOData. type SAPODataConnectorProfileCredentials struct { _ struct{} `type:"structure"` @@ -12802,6 +12845,22 @@ func S3ConnectorOperator_Values() []string { } } +const ( + // S3InputFileTypeCsv is a S3InputFileType enum value + S3InputFileTypeCsv = "CSV" + + // S3InputFileTypeJson is a S3InputFileType enum value + S3InputFileTypeJson = "JSON" +) + +// S3InputFileType_Values returns all elements of the S3InputFileType enum +func S3InputFileType_Values() []string { + return []string{ + S3InputFileTypeCsv, + S3InputFileTypeJson, + } +} + const ( // SAPODataConnectorOperatorProjection is a SAPODataConnectorOperator enum value SAPODataConnectorOperatorProjection = "PROJECTION" diff --git a/service/directconnect/api.go b/service/directconnect/api.go index 02e9026f26..ce430eed57 100644 --- a/service/directconnect/api.go +++ b/service/directconnect/api.go @@ -335,7 +335,8 @@ func (c *DirectConnect) AllocatePrivateVirtualInterfaceRequest(input *AllocatePr // AllocatePrivateVirtualInterface API operation for AWS Direct Connect. // -// Provisions a private virtual interface to be owned by the specified account. +// Provisions a private virtual interface to be owned by the specified Amazon +// Web Services account. // // Virtual interfaces created using this action must be confirmed by the owner // using ConfirmPrivateVirtualInterface. Until then, the virtual interface is @@ -427,10 +428,11 @@ func (c *DirectConnect) AllocatePublicVirtualInterfaceRequest(input *AllocatePub // AllocatePublicVirtualInterface API operation for AWS Direct Connect. // -// Provisions a public virtual interface to be owned by the specified account. +// Provisions a public virtual interface to be owned by the specified Amazon +// Web Services account. // // The owner of a connection calls this function to provision a public virtual -// interface to be owned by the specified account. +// interface to be owned by the specified Amazon Web Services account. // // Virtual interfaces created using this function must be confirmed by the owner // using ConfirmPublicVirtualInterface. Until this step has been completed, @@ -527,12 +529,12 @@ func (c *DirectConnect) AllocateTransitVirtualInterfaceRequest(input *AllocateTr // AllocateTransitVirtualInterface API operation for AWS Direct Connect. // -// Provisions a transit virtual interface to be owned by the specified account. -// Use this type of interface to connect a transit gateway to your Direct Connect -// gateway. +// Provisions a transit virtual interface to be owned by the specified Amazon +// Web Services account. Use this type of interface to connect a transit gateway +// to your Direct Connect gateway. // // The owner of a connection provisions a transit virtual interface to be owned -// by the specified account. +// by the specified Amazon Web Services account. // // After you create a transit virtual interface, it must be confirmed by the // owner using ConfirmTransitVirtualInterface. Until this step has been completed, @@ -1038,6 +1040,89 @@ func (c *DirectConnect) ConfirmConnectionWithContext(ctx aws.Context, input *Con return out, req.Send() } +const opConfirmCustomerAgreement = "ConfirmCustomerAgreement" + +// ConfirmCustomerAgreementRequest generates a "aws/request.Request" representing the +// client's request for the ConfirmCustomerAgreement operation. The "output" return +// value will be populated with the request's response once the request completes +// successfully. +// +// Use "Send" method on the returned Request to send the API call to the service. +// the "output" return value is not valid until after Send returns without error. +// +// See ConfirmCustomerAgreement for more information on using the ConfirmCustomerAgreement +// API call, and error handling. +// +// This method is useful when you want to inject custom logic or configuration +// into the SDK's request lifecycle. Such as custom headers, or retry logic. +// +// +// // Example sending a request using the ConfirmCustomerAgreementRequest method. +// req, resp := client.ConfirmCustomerAgreementRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/directconnect-2012-10-25/ConfirmCustomerAgreement +func (c *DirectConnect) ConfirmCustomerAgreementRequest(input *ConfirmCustomerAgreementInput) (req *request.Request, output *ConfirmCustomerAgreementOutput) { + op := &request.Operation{ + Name: opConfirmCustomerAgreement, + HTTPMethod: "POST", + HTTPPath: "/", + } + + if input == nil { + input = &ConfirmCustomerAgreementInput{} + } + + output = &ConfirmCustomerAgreementOutput{} + req = c.newRequest(op, input, output) + return +} + +// ConfirmCustomerAgreement API operation for AWS Direct Connect. +// +// The confirmation of the terms of agreement when creating the connection/link +// aggregation group (LAG). +// +// Returns awserr.Error for service API and SDK errors. Use runtime type assertions +// with awserr.Error's Code and Message methods to get detailed information about +// the error. +// +// See the AWS API reference guide for AWS Direct Connect's +// API operation ConfirmCustomerAgreement for usage and error information. +// +// Returned Error Types: +// * ServerException +// A server-side error occurred. +// +// * ClientException +// One or more parameters are not valid. +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/directconnect-2012-10-25/ConfirmCustomerAgreement +func (c *DirectConnect) ConfirmCustomerAgreement(input *ConfirmCustomerAgreementInput) (*ConfirmCustomerAgreementOutput, error) { + req, out := c.ConfirmCustomerAgreementRequest(input) + return out, req.Send() +} + +// ConfirmCustomerAgreementWithContext is the same as ConfirmCustomerAgreement with the addition of +// the ability to pass a context and additional request options. +// +// See ConfirmCustomerAgreement for details on how to use this API operation. +// +// The context must be non-nil and will be used for request cancellation. If +// the context is nil a panic will occur. In the future the SDK may create +// sub-contexts for http.Requests. See https://golang.org/pkg/context/ +// for more information on using Contexts. +func (c *DirectConnect) ConfirmCustomerAgreementWithContext(ctx aws.Context, input *ConfirmCustomerAgreementInput, opts ...request.Option) (*ConfirmCustomerAgreementOutput, error) { + req, out := c.ConfirmCustomerAgreementRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + const opConfirmPrivateVirtualInterface = "ConfirmPrivateVirtualInterface" // ConfirmPrivateVirtualInterfaceRequest generates a "aws/request.Request" representing the @@ -1082,7 +1167,8 @@ func (c *DirectConnect) ConfirmPrivateVirtualInterfaceRequest(input *ConfirmPriv // ConfirmPrivateVirtualInterface API operation for AWS Direct Connect. // -// Accepts ownership of a private virtual interface created by another account. +// Accepts ownership of a private virtual interface created by another Amazon +// Web Services account. // // After the virtual interface owner makes this call, the virtual interface // is created and attached to the specified virtual private gateway or Direct @@ -1168,7 +1254,8 @@ func (c *DirectConnect) ConfirmPublicVirtualInterfaceRequest(input *ConfirmPubli // ConfirmPublicVirtualInterface API operation for AWS Direct Connect. // -// Accepts ownership of a public virtual interface created by another account. +// Accepts ownership of a public virtual interface created by another Amazon +// Web Services account. // // After the virtual interface owner makes this call, the specified virtual // interface is created and made available to handle traffic. @@ -1253,7 +1340,8 @@ func (c *DirectConnect) ConfirmTransitVirtualInterfaceRequest(input *ConfirmTran // ConfirmTransitVirtualInterface API operation for AWS Direct Connect. // -// Accepts ownership of a transit virtual interface created by another account. +// Accepts ownership of a transit virtual interface created by another Amazon +// Web Services account. // // After the owner of the transit virtual interface makes this call, the specified // transit virtual interface is created and made available to handle traffic. @@ -1538,11 +1626,12 @@ func (c *DirectConnect) CreateDirectConnectGatewayRequest(input *CreateDirectCon // // Creates a Direct Connect gateway, which is an intermediate object that enables // you to connect a set of virtual interfaces and virtual private gateways. -// A Direct Connect gateway is global and visible in any Region after it is -// created. The virtual interfaces and virtual private gateways that are connected -// through a Direct Connect gateway can be in different Regions. This enables -// you to connect to a VPC in any Region, regardless of the Region in which -// the virtual interfaces are located, and pass traffic between them. +// A Direct Connect gateway is global and visible in any Amazon Web Services +// Region after it is created. The virtual interfaces and virtual private gateways +// that are connected through a Direct Connect gateway can be in different Amazon +// Web Services Regions. This enables you to connect to a VPC in any Region, +// regardless of the Region in which the virtual interfaces are located, and +// pass traffic between them. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -1712,7 +1801,7 @@ func (c *DirectConnect) CreateDirectConnectGatewayAssociationProposalRequest(inp // transit gateway with the specified Direct Connect gateway. // // You can associate a Direct Connect gateway and virtual private gateway or -// transit gateway that is owned by any account. +// transit gateway that is owned by any Amazon Web Services account. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -1925,9 +2014,10 @@ func (c *DirectConnect) CreateLagRequest(input *CreateLagInput) (req *request.Re // associated with the dedicated connection are automatically disassociated // and re-associated with the LAG. The connection ID does not change. // -// If the account used to create a LAG is a registered Direct Connect Partner, -// the LAG is automatically enabled to host sub-connections. For a LAG owned -// by a partner, any associated virtual interfaces cannot be directly configured. +// If the Amazon Web Services account used to create a LAG is a registered Direct +// Connect Partner, the LAG is automatically enabled to host sub-connections. +// For a LAG owned by a partner, any associated virtual interfaces cannot be +// directly configured. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -2019,9 +2109,9 @@ func (c *DirectConnect) CreatePrivateVirtualInterfaceRequest(input *CreatePrivat // transports Direct Connect traffic. A private virtual interface can be connected // to either a Direct Connect gateway or a Virtual Private Gateway (VGW). Connecting // the private virtual interface to a Direct Connect gateway enables the possibility -// for connecting to multiple VPCs, including VPCs in different Regions. Connecting -// the private virtual interface to a VGW only provides access to a single VPC -// within the same Region. +// for connecting to multiple VPCs, including VPCs in different Amazon Web Services +// Regions. Connecting the private virtual interface to a VGW only provides +// access to a single VPC within the same Region. // // Setting the MTU of a virtual interface to 9001 (jumbo frames) can cause an // update to the underlying physical connection if it wasn't updated to support @@ -3222,6 +3312,89 @@ func (c *DirectConnect) DescribeConnectionsOnInterconnectWithContext(ctx aws.Con return out, req.Send() } +const opDescribeCustomerMetadata = "DescribeCustomerMetadata" + +// DescribeCustomerMetadataRequest generates a "aws/request.Request" representing the +// client's request for the DescribeCustomerMetadata operation. The "output" return +// value will be populated with the request's response once the request completes +// successfully. +// +// Use "Send" method on the returned Request to send the API call to the service. +// the "output" return value is not valid until after Send returns without error. +// +// See DescribeCustomerMetadata for more information on using the DescribeCustomerMetadata +// API call, and error handling. +// +// This method is useful when you want to inject custom logic or configuration +// into the SDK's request lifecycle. Such as custom headers, or retry logic. +// +// +// // Example sending a request using the DescribeCustomerMetadataRequest method. +// req, resp := client.DescribeCustomerMetadataRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/directconnect-2012-10-25/DescribeCustomerMetadata +func (c *DirectConnect) DescribeCustomerMetadataRequest(input *DescribeCustomerMetadataInput) (req *request.Request, output *DescribeCustomerMetadataOutput) { + op := &request.Operation{ + Name: opDescribeCustomerMetadata, + HTTPMethod: "POST", + HTTPPath: "/", + } + + if input == nil { + input = &DescribeCustomerMetadataInput{} + } + + output = &DescribeCustomerMetadataOutput{} + req = c.newRequest(op, input, output) + return +} + +// DescribeCustomerMetadata API operation for AWS Direct Connect. +// +// Get and view a list of customer agreements, along with their signed status +// and whether the customer is an NNIPartner, NNIPartnerV2, or a nonPartner. +// +// Returns awserr.Error for service API and SDK errors. Use runtime type assertions +// with awserr.Error's Code and Message methods to get detailed information about +// the error. +// +// See the AWS API reference guide for AWS Direct Connect's +// API operation DescribeCustomerMetadata for usage and error information. +// +// Returned Error Types: +// * ServerException +// A server-side error occurred. +// +// * ClientException +// One or more parameters are not valid. +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/directconnect-2012-10-25/DescribeCustomerMetadata +func (c *DirectConnect) DescribeCustomerMetadata(input *DescribeCustomerMetadataInput) (*DescribeCustomerMetadataOutput, error) { + req, out := c.DescribeCustomerMetadataRequest(input) + return out, req.Send() +} + +// DescribeCustomerMetadataWithContext is the same as DescribeCustomerMetadata with the addition of +// the ability to pass a context and additional request options. +// +// See DescribeCustomerMetadata for details on how to use this API operation. +// +// The context must be non-nil and will be used for request cancellation. If +// the context is nil a panic will occur. In the future the SDK may create +// sub-contexts for http.Requests. See https://golang.org/pkg/context/ +// for more information on using Contexts. +func (c *DirectConnect) DescribeCustomerMetadataWithContext(ctx aws.Context, input *DescribeCustomerMetadataInput, opts ...request.Option) (*DescribeCustomerMetadataOutput, error) { + req, out := c.DescribeCustomerMetadataRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + const opDescribeDirectConnectGatewayAssociationProposals = "DescribeDirectConnectGatewayAssociationProposals" // DescribeDirectConnectGatewayAssociationProposalsRequest generates a "aws/request.Request" representing the @@ -3801,7 +3974,8 @@ func (c *DirectConnect) DescribeInterconnectsRequest(input *DescribeInterconnect // DescribeInterconnects API operation for AWS Direct Connect. // -// Lists the interconnects owned by the account or only the specified interconnect. +// Lists the interconnects owned by the Amazon Web Services account or only +// the specified interconnect. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -4054,8 +4228,9 @@ func (c *DirectConnect) DescribeLocationsRequest(input *DescribeLocationsInput) // DescribeLocations API operation for AWS Direct Connect. // -// Lists the Direct Connect locations in the current Region. These are the locations -// that can be selected when calling CreateConnection or CreateInterconnect. +// Lists the Direct Connect locations in the current Amazon Web Services Region. +// These are the locations that can be selected when calling CreateConnection +// or CreateInterconnect. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -4093,6 +4268,88 @@ func (c *DirectConnect) DescribeLocationsWithContext(ctx aws.Context, input *Des return out, req.Send() } +const opDescribeRouterConfiguration = "DescribeRouterConfiguration" + +// DescribeRouterConfigurationRequest generates a "aws/request.Request" representing the +// client's request for the DescribeRouterConfiguration operation. The "output" return +// value will be populated with the request's response once the request completes +// successfully. +// +// Use "Send" method on the returned Request to send the API call to the service. +// the "output" return value is not valid until after Send returns without error. +// +// See DescribeRouterConfiguration for more information on using the DescribeRouterConfiguration +// API call, and error handling. +// +// This method is useful when you want to inject custom logic or configuration +// into the SDK's request lifecycle. Such as custom headers, or retry logic. +// +// +// // Example sending a request using the DescribeRouterConfigurationRequest method. +// req, resp := client.DescribeRouterConfigurationRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/directconnect-2012-10-25/DescribeRouterConfiguration +func (c *DirectConnect) DescribeRouterConfigurationRequest(input *DescribeRouterConfigurationInput) (req *request.Request, output *DescribeRouterConfigurationOutput) { + op := &request.Operation{ + Name: opDescribeRouterConfiguration, + HTTPMethod: "POST", + HTTPPath: "/", + } + + if input == nil { + input = &DescribeRouterConfigurationInput{} + } + + output = &DescribeRouterConfigurationOutput{} + req = c.newRequest(op, input, output) + return +} + +// DescribeRouterConfiguration API operation for AWS Direct Connect. +// +// Details about the router. +// +// Returns awserr.Error for service API and SDK errors. Use runtime type assertions +// with awserr.Error's Code and Message methods to get detailed information about +// the error. +// +// See the AWS API reference guide for AWS Direct Connect's +// API operation DescribeRouterConfiguration for usage and error information. +// +// Returned Error Types: +// * ServerException +// A server-side error occurred. +// +// * ClientException +// One or more parameters are not valid. +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/directconnect-2012-10-25/DescribeRouterConfiguration +func (c *DirectConnect) DescribeRouterConfiguration(input *DescribeRouterConfigurationInput) (*DescribeRouterConfigurationOutput, error) { + req, out := c.DescribeRouterConfigurationRequest(input) + return out, req.Send() +} + +// DescribeRouterConfigurationWithContext is the same as DescribeRouterConfiguration with the addition of +// the ability to pass a context and additional request options. +// +// See DescribeRouterConfiguration for details on how to use this API operation. +// +// The context must be non-nil and will be used for request cancellation. If +// the context is nil a panic will occur. In the future the SDK may create +// sub-contexts for http.Requests. See https://golang.org/pkg/context/ +// for more information on using Contexts. +func (c *DirectConnect) DescribeRouterConfigurationWithContext(ctx aws.Context, input *DescribeRouterConfigurationInput, opts ...request.Option) (*DescribeRouterConfigurationOutput, error) { + req, out := c.DescribeRouterConfigurationRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + const opDescribeTags = "DescribeTags" // DescribeTagsRequest generates a "aws/request.Request" representing the @@ -4219,7 +4476,7 @@ func (c *DirectConnect) DescribeVirtualGatewaysRequest(input *DescribeVirtualGat // DescribeVirtualGateways API operation for AWS Direct Connect. // -// Lists the virtual private gateways owned by the account. +// Lists the virtual private gateways owned by the Amazon Web Services account. // // You can create one or more Direct Connect private virtual interfaces linked // to a virtual private gateway. @@ -4304,11 +4561,11 @@ func (c *DirectConnect) DescribeVirtualInterfacesRequest(input *DescribeVirtualI // DescribeVirtualInterfaces API operation for AWS Direct Connect. // -// Displays all virtual interfaces for an account. Virtual interfaces deleted -// fewer than 15 minutes before you make the request are also returned. If you -// specify a connection ID, only the virtual interfaces associated with the -// connection are returned. If you specify a virtual interface ID, then only -// a single virtual interface is returned. +// Displays all virtual interfaces for an Amazon Web Services account. Virtual +// interfaces deleted fewer than 15 minutes before you make the request are +// also returned. If you specify a connection ID, only the virtual interfaces +// associated with the connection are returned. If you specify a virtual interface +// ID, then only a single virtual interface is returned. // // A virtual interface (VLAN) transmits the traffic between the Direct Connect // location and the customer network. @@ -5044,6 +5301,88 @@ func (c *DirectConnect) UpdateConnectionWithContext(ctx aws.Context, input *Upda return out, req.Send() } +const opUpdateDirectConnectGateway = "UpdateDirectConnectGateway" + +// UpdateDirectConnectGatewayRequest generates a "aws/request.Request" representing the +// client's request for the UpdateDirectConnectGateway operation. The "output" return +// value will be populated with the request's response once the request completes +// successfully. +// +// Use "Send" method on the returned Request to send the API call to the service. +// the "output" return value is not valid until after Send returns without error. +// +// See UpdateDirectConnectGateway for more information on using the UpdateDirectConnectGateway +// API call, and error handling. +// +// This method is useful when you want to inject custom logic or configuration +// into the SDK's request lifecycle. Such as custom headers, or retry logic. +// +// +// // Example sending a request using the UpdateDirectConnectGatewayRequest method. +// req, resp := client.UpdateDirectConnectGatewayRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/directconnect-2012-10-25/UpdateDirectConnectGateway +func (c *DirectConnect) UpdateDirectConnectGatewayRequest(input *UpdateDirectConnectGatewayInput) (req *request.Request, output *UpdateDirectConnectGatewayOutput) { + op := &request.Operation{ + Name: opUpdateDirectConnectGateway, + HTTPMethod: "POST", + HTTPPath: "/", + } + + if input == nil { + input = &UpdateDirectConnectGatewayInput{} + } + + output = &UpdateDirectConnectGatewayOutput{} + req = c.newRequest(op, input, output) + return +} + +// UpdateDirectConnectGateway API operation for AWS Direct Connect. +// +// Updates the name of a current Direct Connect gateway. +// +// Returns awserr.Error for service API and SDK errors. Use runtime type assertions +// with awserr.Error's Code and Message methods to get detailed information about +// the error. +// +// See the AWS API reference guide for AWS Direct Connect's +// API operation UpdateDirectConnectGateway for usage and error information. +// +// Returned Error Types: +// * ServerException +// A server-side error occurred. +// +// * ClientException +// One or more parameters are not valid. +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/directconnect-2012-10-25/UpdateDirectConnectGateway +func (c *DirectConnect) UpdateDirectConnectGateway(input *UpdateDirectConnectGatewayInput) (*UpdateDirectConnectGatewayOutput, error) { + req, out := c.UpdateDirectConnectGatewayRequest(input) + return out, req.Send() +} + +// UpdateDirectConnectGatewayWithContext is the same as UpdateDirectConnectGateway with the addition of +// the ability to pass a context and additional request options. +// +// See UpdateDirectConnectGateway for details on how to use this API operation. +// +// The context must be non-nil and will be used for request cancellation. If +// the context is nil a panic will occur. In the future the SDK may create +// sub-contexts for http.Requests. See https://golang.org/pkg/context/ +// for more information on using Contexts. +func (c *DirectConnect) UpdateDirectConnectGatewayWithContext(ctx aws.Context, input *UpdateDirectConnectGatewayInput, opts ...request.Option) (*UpdateDirectConnectGatewayOutput, error) { + req, out := c.UpdateDirectConnectGatewayRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + const opUpdateDirectConnectGatewayAssociation = "UpdateDirectConnectGatewayAssociation" // UpdateDirectConnectGatewayAssociationRequest generates a "aws/request.Request" representing the @@ -5318,7 +5657,8 @@ func (c *DirectConnect) UpdateVirtualInterfaceAttributesWithContext(ctx aws.Cont type AcceptDirectConnectGatewayAssociationProposalInput struct { _ struct{} `type:"structure"` - // The ID of the account that owns the virtual private gateway or transit gateway. + // The ID of the Amazon Web Services account that owns the virtual private gateway + // or transit gateway. // // AssociatedGatewayOwnerAccount is a required field AssociatedGatewayOwnerAccount *string `locationName:"associatedGatewayOwnerAccount" type:"string" required:"true"` @@ -5454,7 +5794,8 @@ type AllocateConnectionOnInterconnectInput struct { // InterconnectId is a required field InterconnectId *string `locationName:"interconnectId" type:"string" required:"true"` - // The ID of the account of the customer for whom the connection will be provisioned. + // The ID of the Amazon Web Services account of the customer for whom the connection + // will be provisioned. // // OwnerAccount is a required field OwnerAccount *string `locationName:"ownerAccount" type:"string" required:"true"` @@ -5559,7 +5900,7 @@ type AllocateHostedConnectionInput struct { // ConnectionName is a required field ConnectionName *string `locationName:"connectionName" type:"string" required:"true"` - // The ID of the account ID of the customer for the connection. + // The ID of the Amazon Web Services account ID of the customer for the connection. // // OwnerAccount is a required field OwnerAccount *string `locationName:"ownerAccount" type:"string" required:"true"` @@ -5678,7 +6019,7 @@ type AllocatePrivateVirtualInterfaceInput struct { // NewPrivateVirtualInterfaceAllocation is a required field NewPrivateVirtualInterfaceAllocation *NewPrivateVirtualInterfaceAllocation `locationName:"newPrivateVirtualInterfaceAllocation" type:"structure" required:"true"` - // The ID of the account that owns the virtual private interface. + // The ID of the Amazon Web Services account that owns the virtual private interface. // // OwnerAccount is a required field OwnerAccount *string `locationName:"ownerAccount" type:"string" required:"true"` @@ -5757,7 +6098,7 @@ type AllocatePublicVirtualInterfaceInput struct { // NewPublicVirtualInterfaceAllocation is a required field NewPublicVirtualInterfaceAllocation *NewPublicVirtualInterfaceAllocation `locationName:"newPublicVirtualInterfaceAllocation" type:"structure" required:"true"` - // The ID of the account that owns the public virtual interface. + // The ID of the Amazon Web Services account that owns the public virtual interface. // // OwnerAccount is a required field OwnerAccount *string `locationName:"ownerAccount" type:"string" required:"true"` @@ -5836,7 +6177,7 @@ type AllocateTransitVirtualInterfaceInput struct { // NewTransitVirtualInterfaceAllocation is a required field NewTransitVirtualInterfaceAllocation *NewTransitVirtualInterfaceAllocation `locationName:"newTransitVirtualInterfaceAllocation" type:"structure" required:"true"` - // The ID of the account that owns the transit virtual interface. + // The ID of the Amazon Web Services account that owns the transit virtual interface. // // OwnerAccount is a required field OwnerAccount *string `locationName:"ownerAccount" type:"string" required:"true"` @@ -6256,8 +6597,8 @@ type AssociatedGateway struct { // The ID of the associated gateway. Id *string `locationName:"id" type:"string"` - // The ID of the account that owns the associated virtual private gateway or - // transit gateway. + // The ID of the Amazon Web Services account that owns the associated virtual + // private gateway or transit gateway. OwnerAccount *string `locationName:"ownerAccount" type:"string"` // The Region where the associated gateway is located. @@ -6609,6 +6950,69 @@ func (s *ConfirmConnectionOutput) SetConnectionState(v string) *ConfirmConnectio return s } +type ConfirmCustomerAgreementInput struct { + _ struct{} `type:"structure"` + + // The name of the customer agreement. + AgreementName *string `locationName:"agreementName" type:"string"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ConfirmCustomerAgreementInput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ConfirmCustomerAgreementInput) GoString() string { + return s.String() +} + +// SetAgreementName sets the AgreementName field's value. +func (s *ConfirmCustomerAgreementInput) SetAgreementName(v string) *ConfirmCustomerAgreementInput { + s.AgreementName = &v + return s +} + +type ConfirmCustomerAgreementOutput struct { + _ struct{} `type:"structure"` + + // The status of the customer agreement when the connection was created. This + // will be either signed or unsigned. + Status *string `locationName:"status" type:"string"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ConfirmCustomerAgreementOutput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ConfirmCustomerAgreementOutput) GoString() string { + return s.String() +} + +// SetStatus sets the Status field's value. +func (s *ConfirmCustomerAgreementOutput) SetStatus(v string) *ConfirmCustomerAgreementOutput { + s.Status = &v + return s +} + type ConfirmPrivateVirtualInterfaceInput struct { _ struct{} `type:"structure"` @@ -7035,7 +7439,7 @@ type Connection struct { // The MAC Security (MACsec) security keys associated with the connection. MacSecKeys []*MacSecKey `locationName:"macSecKeys" type:"list"` - // The ID of the account that owns the connection. + // The ID of the Amazon Web Services account that owns the connection. OwnerAccount *string `locationName:"ownerAccount" type:"string"` // The name of the Direct Connect service provider associated with the connection. @@ -7050,7 +7454,7 @@ type Connection struct { // The name of the service provider associated with the connection. ProviderName *string `locationName:"providerName" type:"string"` - // The Region where the connection is located. + // The Amazon Web Services Region where the connection is located. Region *string `locationName:"region" type:"string"` // The tags associated with the connection. @@ -7559,7 +7963,7 @@ type CreateDirectConnectGatewayAssociationProposalInput struct { // DirectConnectGatewayId is a required field DirectConnectGatewayId *string `locationName:"directConnectGatewayId" type:"string" required:"true"` - // The ID of the account that owns the Direct Connect gateway. + // The ID of the Amazon Web Services account that owns the Direct Connect gateway. // // DirectConnectGatewayOwnerAccount is a required field DirectConnectGatewayOwnerAccount *string `locationName:"directConnectGatewayOwnerAccount" type:"string" required:"true"` @@ -8266,6 +8670,47 @@ func (s *CreateTransitVirtualInterfaceOutput) SetVirtualInterface(v *VirtualInte return s } +// The name and status of a customer agreement. +type CustomerAgreement struct { + _ struct{} `type:"structure"` + + // The name of the agreement. + AgreementName *string `locationName:"agreementName" type:"string"` + + // The status of the customer agreement. This will be either signed or unsigned + Status *string `locationName:"status" type:"string"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s CustomerAgreement) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s CustomerAgreement) GoString() string { + return s.String() +} + +// SetAgreementName sets the AgreementName field's value. +func (s *CustomerAgreement) SetAgreementName(v string) *CustomerAgreement { + s.AgreementName = &v + return s +} + +// SetStatus sets the Status field's value. +func (s *CustomerAgreement) SetStatus(v string) *CustomerAgreement { + s.Status = &v + return s +} + type DeleteBGPPeerInput struct { _ struct{} `type:"structure"` @@ -8973,17 +9418,91 @@ func (s DescribeConnectionLoaOutput) GoString() string { return s.String() } -// SetLoa sets the Loa field's value. -func (s *DescribeConnectionLoaOutput) SetLoa(v *Loa) *DescribeConnectionLoaOutput { - s.Loa = v +// SetLoa sets the Loa field's value. +func (s *DescribeConnectionLoaOutput) SetLoa(v *Loa) *DescribeConnectionLoaOutput { + s.Loa = v + return s +} + +type DescribeConnectionsInput struct { + _ struct{} `type:"structure"` + + // The ID of the connection. + ConnectionId *string `locationName:"connectionId" type:"string"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s DescribeConnectionsInput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s DescribeConnectionsInput) GoString() string { + return s.String() +} + +// SetConnectionId sets the ConnectionId field's value. +func (s *DescribeConnectionsInput) SetConnectionId(v string) *DescribeConnectionsInput { + s.ConnectionId = &v + return s +} + +type DescribeConnectionsOnInterconnectInput struct { + _ struct{} `type:"structure"` + + // The ID of the interconnect. + // + // InterconnectId is a required field + InterconnectId *string `locationName:"interconnectId" type:"string" required:"true"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s DescribeConnectionsOnInterconnectInput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s DescribeConnectionsOnInterconnectInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *DescribeConnectionsOnInterconnectInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "DescribeConnectionsOnInterconnectInput"} + if s.InterconnectId == nil { + invalidParams.Add(request.NewErrParamRequired("InterconnectId")) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetInterconnectId sets the InterconnectId field's value. +func (s *DescribeConnectionsOnInterconnectInput) SetInterconnectId(v string) *DescribeConnectionsOnInterconnectInput { + s.InterconnectId = &v return s } -type DescribeConnectionsInput struct { +type DescribeCustomerMetadataInput struct { _ struct{} `type:"structure"` - - // The ID of the connection. - ConnectionId *string `locationName:"connectionId" type:"string"` } // String returns the string representation. @@ -8991,7 +9510,7 @@ type DescribeConnectionsInput struct { // API parameter values that are decorated as "sensitive" in the API will not // be included in the string output. The member name will be present, but the // value will be replaced with "sensitive". -func (s DescribeConnectionsInput) String() string { +func (s DescribeCustomerMetadataInput) String() string { return awsutil.Prettify(s) } @@ -9000,23 +9519,26 @@ func (s DescribeConnectionsInput) String() string { // API parameter values that are decorated as "sensitive" in the API will not // be included in the string output. The member name will be present, but the // value will be replaced with "sensitive". -func (s DescribeConnectionsInput) GoString() string { +func (s DescribeCustomerMetadataInput) GoString() string { return s.String() } -// SetConnectionId sets the ConnectionId field's value. -func (s *DescribeConnectionsInput) SetConnectionId(v string) *DescribeConnectionsInput { - s.ConnectionId = &v - return s -} - -type DescribeConnectionsOnInterconnectInput struct { +type DescribeCustomerMetadataOutput struct { _ struct{} `type:"structure"` - // The ID of the interconnect. + // The list of customer agreements. + Agreements []*CustomerAgreement `locationName:"agreements" type:"list"` + + // The type of network-to-network interface (NNI) partner. The partner type + // will be one of the following: // - // InterconnectId is a required field - InterconnectId *string `locationName:"interconnectId" type:"string" required:"true"` + // * V1: This partner can only allocate 50Mbps, 100Mbps, 200Mbps, 300Mbps, + // 400Mbps, or 500Mbps subgigabit connections. + // + // * V2: This partner can only allocate 1GB, 2GB, 5GB, or 10GB hosted connections. + // + // * nonPartner: The customer is not a partner. + NniPartnerType *string `locationName:"nniPartnerType" type:"string" enum:"NniPartnerType"` } // String returns the string representation. @@ -9024,7 +9546,7 @@ type DescribeConnectionsOnInterconnectInput struct { // API parameter values that are decorated as "sensitive" in the API will not // be included in the string output. The member name will be present, but the // value will be replaced with "sensitive". -func (s DescribeConnectionsOnInterconnectInput) String() string { +func (s DescribeCustomerMetadataOutput) String() string { return awsutil.Prettify(s) } @@ -9033,26 +9555,19 @@ func (s DescribeConnectionsOnInterconnectInput) String() string { // API parameter values that are decorated as "sensitive" in the API will not // be included in the string output. The member name will be present, but the // value will be replaced with "sensitive". -func (s DescribeConnectionsOnInterconnectInput) GoString() string { +func (s DescribeCustomerMetadataOutput) GoString() string { return s.String() } -// Validate inspects the fields of the type to determine if they are valid. -func (s *DescribeConnectionsOnInterconnectInput) Validate() error { - invalidParams := request.ErrInvalidParams{Context: "DescribeConnectionsOnInterconnectInput"} - if s.InterconnectId == nil { - invalidParams.Add(request.NewErrParamRequired("InterconnectId")) - } - - if invalidParams.Len() > 0 { - return invalidParams - } - return nil +// SetAgreements sets the Agreements field's value. +func (s *DescribeCustomerMetadataOutput) SetAgreements(v []*CustomerAgreement) *DescribeCustomerMetadataOutput { + s.Agreements = v + return s } -// SetInterconnectId sets the InterconnectId field's value. -func (s *DescribeConnectionsOnInterconnectInput) SetInterconnectId(v string) *DescribeConnectionsOnInterconnectInput { - s.InterconnectId = &v +// SetNniPartnerType sets the NniPartnerType field's value. +func (s *DescribeCustomerMetadataOutput) SetNniPartnerType(v string) *DescribeCustomerMetadataOutput { + s.NniPartnerType = &v return s } @@ -9867,6 +10382,121 @@ func (s *DescribeLocationsOutput) SetLocations(v []*Location) *DescribeLocations return s } +// Provides the details about a virtual interface's router. +type DescribeRouterConfigurationInput struct { + _ struct{} `type:"structure"` + + // Identifies the router by a combination of vendor, platform, and software + // version. For example, CiscoSystemsInc-2900SeriesRouters-IOS124. + RouterTypeIdentifier *string `locationName:"routerTypeIdentifier" type:"string"` + + // The ID of the virtual interface. + // + // VirtualInterfaceId is a required field + VirtualInterfaceId *string `locationName:"virtualInterfaceId" type:"string" required:"true"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s DescribeRouterConfigurationInput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s DescribeRouterConfigurationInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *DescribeRouterConfigurationInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "DescribeRouterConfigurationInput"} + if s.VirtualInterfaceId == nil { + invalidParams.Add(request.NewErrParamRequired("VirtualInterfaceId")) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetRouterTypeIdentifier sets the RouterTypeIdentifier field's value. +func (s *DescribeRouterConfigurationInput) SetRouterTypeIdentifier(v string) *DescribeRouterConfigurationInput { + s.RouterTypeIdentifier = &v + return s +} + +// SetVirtualInterfaceId sets the VirtualInterfaceId field's value. +func (s *DescribeRouterConfigurationInput) SetVirtualInterfaceId(v string) *DescribeRouterConfigurationInput { + s.VirtualInterfaceId = &v + return s +} + +type DescribeRouterConfigurationOutput struct { + _ struct{} `type:"structure"` + + // The customer router configuration. + CustomerRouterConfig *string `locationName:"customerRouterConfig" type:"string"` + + // The details about the router. + Router *RouterType `locationName:"router" type:"structure"` + + // The ID assigned to the virtual interface. + VirtualInterfaceId *string `locationName:"virtualInterfaceId" type:"string"` + + // The name of the virtual interface assigned by the customer network. + VirtualInterfaceName *string `locationName:"virtualInterfaceName" type:"string"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s DescribeRouterConfigurationOutput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s DescribeRouterConfigurationOutput) GoString() string { + return s.String() +} + +// SetCustomerRouterConfig sets the CustomerRouterConfig field's value. +func (s *DescribeRouterConfigurationOutput) SetCustomerRouterConfig(v string) *DescribeRouterConfigurationOutput { + s.CustomerRouterConfig = &v + return s +} + +// SetRouter sets the Router field's value. +func (s *DescribeRouterConfigurationOutput) SetRouter(v *RouterType) *DescribeRouterConfigurationOutput { + s.Router = v + return s +} + +// SetVirtualInterfaceId sets the VirtualInterfaceId field's value. +func (s *DescribeRouterConfigurationOutput) SetVirtualInterfaceId(v string) *DescribeRouterConfigurationOutput { + s.VirtualInterfaceId = &v + return s +} + +// SetVirtualInterfaceName sets the VirtualInterfaceName field's value. +func (s *DescribeRouterConfigurationOutput) SetVirtualInterfaceName(v string) *DescribeRouterConfigurationOutput { + s.VirtualInterfaceName = &v + return s +} + type DescribeTagsInput struct { _ struct{} `type:"structure"` @@ -10323,7 +10953,7 @@ type Gateway struct { // * deleted: The Direct Connect gateway is deleted and cannot pass traffic. DirectConnectGatewayState *string `locationName:"directConnectGatewayState" type:"string" enum:"GatewayState"` - // The ID of the account that owns the Direct Connect gateway. + // The ID of the Amazon Web Services account that owns the Direct Connect gateway. OwnerAccount *string `locationName:"ownerAccount" type:"string"` // The error message if the state of an object failed to advance. @@ -10415,7 +11045,7 @@ type GatewayAssociation struct { // The ID of the Direct Connect gateway. DirectConnectGatewayId *string `locationName:"directConnectGatewayId" type:"string"` - // The ID of the account that owns the associated gateway. + // The ID of the Amazon Web Services account that owns the associated gateway. DirectConnectGatewayOwnerAccount *string `locationName:"directConnectGatewayOwnerAccount" type:"string"` // The error message if the state of an object failed to advance. @@ -10424,10 +11054,10 @@ type GatewayAssociation struct { // The ID of the virtual private gateway. Applies only to private virtual interfaces. VirtualGatewayId *string `locationName:"virtualGatewayId" type:"string"` - // The ID of the account that owns the virtual private gateway. + // The ID of the Amazon Web Services account that owns the virtual private gateway. VirtualGatewayOwnerAccount *string `locationName:"virtualGatewayOwnerAccount" type:"string"` - // The Region where the virtual private gateway is located. + // The Amazon Web Services Region where the virtual private gateway is located. VirtualGatewayRegion *string `locationName:"virtualGatewayRegion" deprecated:"true" type:"string"` } @@ -10520,7 +11150,7 @@ type GatewayAssociationProposal struct { // The ID of the Direct Connect gateway. DirectConnectGatewayId *string `locationName:"directConnectGatewayId" type:"string"` - // The ID of the account that owns the Direct Connect gateway. + // The ID of the Amazon Web Services account that owns the Direct Connect gateway. DirectConnectGatewayOwnerAccount *string `locationName:"directConnectGatewayOwnerAccount" type:"string"` // The existing Amazon VPC prefixes advertised to the Direct Connect gateway. @@ -10637,10 +11267,10 @@ type GatewayAttachment struct { // The ID of the virtual interface. VirtualInterfaceId *string `locationName:"virtualInterfaceId" type:"string"` - // The ID of the account that owns the virtual interface. + // The ID of the Amazon Web Services account that owns the virtual interface. VirtualInterfaceOwnerAccount *string `locationName:"virtualInterfaceOwnerAccount" type:"string"` - // The Region where the virtual interface is located. + // The Amazon Web Services Region where the virtual interface is located. VirtualInterfaceRegion *string `locationName:"virtualInterfaceRegion" type:"string"` } @@ -10766,7 +11396,7 @@ type Interconnect struct { // The name of the service provider associated with the interconnect. ProviderName *string `locationName:"providerName" type:"string"` - // The Region where the connection is located. + // The Amazon Web Services Region where the connection is located. Region *string `locationName:"region" type:"string"` // The tags associated with the interconnect. @@ -10959,13 +11589,13 @@ type Lag struct { // maximum of 10. NumberOfConnections *int64 `locationName:"numberOfConnections" type:"integer"` - // The ID of the account that owns the LAG. + // The ID of the Amazon Web Services account that owns the LAG. OwnerAccount *string `locationName:"ownerAccount" type:"string"` // The name of the service provider associated with the LAG. ProviderName *string `locationName:"providerName" type:"string"` - // The Region where the connection is located. + // The Amazon Web Services Region where the connection is located. Region *string `locationName:"region" type:"string"` // The tags associated with the LAG. @@ -11301,7 +11931,7 @@ type Location struct { // and the physical site of the building. LocationName *string `locationName:"locationName" type:"string"` - // The Region for the location. + // The Amazon Web Services Region for the location. Region *string `locationName:"region" type:"string"` } @@ -12462,6 +13092,84 @@ func (s *RouteFilterPrefix) SetCidr(v string) *RouteFilterPrefix { return s } +// Information about the virtual router. +type RouterType struct { + _ struct{} `type:"structure"` + + // The virtual interface router platform. + Platform *string `locationName:"platform" type:"string"` + + // Identifies the router by a combination of vendor, platform, and software + // version. For example, CiscoSystemsInc-2900SeriesRouters-IOS124. + RouterTypeIdentifier *string `locationName:"routerTypeIdentifier" type:"string"` + + // The router software. + Software *string `locationName:"software" type:"string"` + + // The vendor for the virtual interface's router. + Vendor *string `locationName:"vendor" type:"string"` + + // The template for the virtual interface's router. + XsltTemplateName *string `locationName:"xsltTemplateName" type:"string"` + + // The MAC Security (MACsec) template for the virtual interface's router. + XsltTemplateNameForMacSec *string `locationName:"xsltTemplateNameForMacSec" type:"string"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s RouterType) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s RouterType) GoString() string { + return s.String() +} + +// SetPlatform sets the Platform field's value. +func (s *RouterType) SetPlatform(v string) *RouterType { + s.Platform = &v + return s +} + +// SetRouterTypeIdentifier sets the RouterTypeIdentifier field's value. +func (s *RouterType) SetRouterTypeIdentifier(v string) *RouterType { + s.RouterTypeIdentifier = &v + return s +} + +// SetSoftware sets the Software field's value. +func (s *RouterType) SetSoftware(v string) *RouterType { + s.Software = &v + return s +} + +// SetVendor sets the Vendor field's value. +func (s *RouterType) SetVendor(v string) *RouterType { + s.Vendor = &v + return s +} + +// SetXsltTemplateName sets the XsltTemplateName field's value. +func (s *RouterType) SetXsltTemplateName(v string) *RouterType { + s.XsltTemplateName = &v + return s +} + +// SetXsltTemplateNameForMacSec sets the XsltTemplateNameForMacSec field's value. +func (s *RouterType) SetXsltTemplateNameForMacSec(v string) *RouterType { + s.XsltTemplateNameForMacSec = &v + return s +} + // A server-side error occurred. type ServerException struct { _ struct{} `type:"structure"` @@ -13146,7 +13854,7 @@ type UpdateConnectionOutput struct { // The MAC Security (MACsec) security keys associated with the connection. MacSecKeys []*MacSecKey `locationName:"macSecKeys" type:"list"` - // The ID of the account that owns the connection. + // The ID of the Amazon Web Services account that owns the connection. OwnerAccount *string `locationName:"ownerAccount" type:"string"` // The name of the Direct Connect service provider associated with the connection. @@ -13161,7 +13869,7 @@ type UpdateConnectionOutput struct { // The name of the service provider associated with the connection. ProviderName *string `locationName:"providerName" type:"string"` - // The Region where the connection is located. + // The Amazon Web Services Region where the connection is located. Region *string `locationName:"region" type:"string"` // The tags associated with the connection. @@ -13402,6 +14110,98 @@ func (s *UpdateDirectConnectGatewayAssociationOutput) SetDirectConnectGatewayAss return s } +type UpdateDirectConnectGatewayInput struct { + _ struct{} `type:"structure"` + + // The ID of the Direct Connect gateway to update. + // + // DirectConnectGatewayId is a required field + DirectConnectGatewayId *string `locationName:"directConnectGatewayId" type:"string" required:"true"` + + // The new name for the Direct Connect gateway. + // + // NewDirectConnectGatewayName is a required field + NewDirectConnectGatewayName *string `locationName:"newDirectConnectGatewayName" type:"string" required:"true"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s UpdateDirectConnectGatewayInput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s UpdateDirectConnectGatewayInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *UpdateDirectConnectGatewayInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "UpdateDirectConnectGatewayInput"} + if s.DirectConnectGatewayId == nil { + invalidParams.Add(request.NewErrParamRequired("DirectConnectGatewayId")) + } + if s.NewDirectConnectGatewayName == nil { + invalidParams.Add(request.NewErrParamRequired("NewDirectConnectGatewayName")) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetDirectConnectGatewayId sets the DirectConnectGatewayId field's value. +func (s *UpdateDirectConnectGatewayInput) SetDirectConnectGatewayId(v string) *UpdateDirectConnectGatewayInput { + s.DirectConnectGatewayId = &v + return s +} + +// SetNewDirectConnectGatewayName sets the NewDirectConnectGatewayName field's value. +func (s *UpdateDirectConnectGatewayInput) SetNewDirectConnectGatewayName(v string) *UpdateDirectConnectGatewayInput { + s.NewDirectConnectGatewayName = &v + return s +} + +type UpdateDirectConnectGatewayOutput struct { + _ struct{} `type:"structure"` + + // Information about a Direct Connect gateway, which enables you to connect + // virtual interfaces and virtual private gateway or transit gateways. + DirectConnectGateway *Gateway `locationName:"directConnectGateway" type:"structure"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s UpdateDirectConnectGatewayOutput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s UpdateDirectConnectGatewayOutput) GoString() string { + return s.String() +} + +// SetDirectConnectGateway sets the DirectConnectGateway field's value. +func (s *UpdateDirectConnectGatewayOutput) SetDirectConnectGateway(v *Gateway) *UpdateDirectConnectGatewayOutput { + s.DirectConnectGateway = v + return s +} + type UpdateLagInput struct { _ struct{} `type:"structure"` @@ -13589,10 +14389,10 @@ type UpdateVirtualInterfaceAttributesOutput struct { // and 9001. The default value is 1500. Mtu *int64 `locationName:"mtu" type:"integer"` - // The ID of the account that owns the virtual interface. + // The ID of the Amazon Web Services account that owns the virtual interface. OwnerAccount *string `locationName:"ownerAccount" type:"string"` - // The Region where the virtual interface is located. + // The Amazon Web Services Region where the virtual interface is located. Region *string `locationName:"region" type:"string"` // The routes to be advertised to the Amazon Web Services network in this Region. @@ -13925,10 +14725,10 @@ type VirtualInterface struct { // and 9001. The default value is 1500. Mtu *int64 `locationName:"mtu" type:"integer"` - // The ID of the account that owns the virtual interface. + // The ID of the Amazon Web Services account that owns the virtual interface. OwnerAccount *string `locationName:"ownerAccount" type:"string"` - // The Region where the virtual interface is located. + // The Amazon Web Services Region where the virtual interface is located. Region *string `locationName:"region" type:"string"` // The routes to be advertised to the Amazon Web Services network in this Region. @@ -14592,6 +15392,26 @@ func LoaContentType_Values() []string { } } +const ( + // NniPartnerTypeV1 is a NniPartnerType enum value + NniPartnerTypeV1 = "v1" + + // NniPartnerTypeV2 is a NniPartnerType enum value + NniPartnerTypeV2 = "v2" + + // NniPartnerTypeNonPartner is a NniPartnerType enum value + NniPartnerTypeNonPartner = "nonPartner" +) + +// NniPartnerType_Values returns all elements of the NniPartnerType enum +func NniPartnerType_Values() []string { + return []string{ + NniPartnerTypeV1, + NniPartnerTypeV2, + NniPartnerTypeNonPartner, + } +} + const ( // VirtualInterfaceStateConfirming is a VirtualInterfaceState enum value VirtualInterfaceStateConfirming = "confirming" diff --git a/service/directconnect/directconnectiface/interface.go b/service/directconnect/directconnectiface/interface.go index 58759ae746..74d8c1b510 100644 --- a/service/directconnect/directconnectiface/interface.go +++ b/service/directconnect/directconnectiface/interface.go @@ -104,6 +104,10 @@ type DirectConnectAPI interface { ConfirmConnectionWithContext(aws.Context, *directconnect.ConfirmConnectionInput, ...request.Option) (*directconnect.ConfirmConnectionOutput, error) ConfirmConnectionRequest(*directconnect.ConfirmConnectionInput) (*request.Request, *directconnect.ConfirmConnectionOutput) + ConfirmCustomerAgreement(*directconnect.ConfirmCustomerAgreementInput) (*directconnect.ConfirmCustomerAgreementOutput, error) + ConfirmCustomerAgreementWithContext(aws.Context, *directconnect.ConfirmCustomerAgreementInput, ...request.Option) (*directconnect.ConfirmCustomerAgreementOutput, error) + ConfirmCustomerAgreementRequest(*directconnect.ConfirmCustomerAgreementInput) (*request.Request, *directconnect.ConfirmCustomerAgreementOutput) + ConfirmPrivateVirtualInterface(*directconnect.ConfirmPrivateVirtualInterfaceInput) (*directconnect.ConfirmPrivateVirtualInterfaceOutput, error) ConfirmPrivateVirtualInterfaceWithContext(aws.Context, *directconnect.ConfirmPrivateVirtualInterfaceInput, ...request.Option) (*directconnect.ConfirmPrivateVirtualInterfaceOutput, error) ConfirmPrivateVirtualInterfaceRequest(*directconnect.ConfirmPrivateVirtualInterfaceInput) (*request.Request, *directconnect.ConfirmPrivateVirtualInterfaceOutput) @@ -200,6 +204,10 @@ type DirectConnectAPI interface { DescribeConnectionsOnInterconnectWithContext(aws.Context, *directconnect.DescribeConnectionsOnInterconnectInput, ...request.Option) (*directconnect.Connections, error) DescribeConnectionsOnInterconnectRequest(*directconnect.DescribeConnectionsOnInterconnectInput) (*request.Request, *directconnect.Connections) + DescribeCustomerMetadata(*directconnect.DescribeCustomerMetadataInput) (*directconnect.DescribeCustomerMetadataOutput, error) + DescribeCustomerMetadataWithContext(aws.Context, *directconnect.DescribeCustomerMetadataInput, ...request.Option) (*directconnect.DescribeCustomerMetadataOutput, error) + DescribeCustomerMetadataRequest(*directconnect.DescribeCustomerMetadataInput) (*request.Request, *directconnect.DescribeCustomerMetadataOutput) + DescribeDirectConnectGatewayAssociationProposals(*directconnect.DescribeDirectConnectGatewayAssociationProposalsInput) (*directconnect.DescribeDirectConnectGatewayAssociationProposalsOutput, error) DescribeDirectConnectGatewayAssociationProposalsWithContext(aws.Context, *directconnect.DescribeDirectConnectGatewayAssociationProposalsInput, ...request.Option) (*directconnect.DescribeDirectConnectGatewayAssociationProposalsOutput, error) DescribeDirectConnectGatewayAssociationProposalsRequest(*directconnect.DescribeDirectConnectGatewayAssociationProposalsInput) (*request.Request, *directconnect.DescribeDirectConnectGatewayAssociationProposalsOutput) @@ -240,6 +248,10 @@ type DirectConnectAPI interface { DescribeLocationsWithContext(aws.Context, *directconnect.DescribeLocationsInput, ...request.Option) (*directconnect.DescribeLocationsOutput, error) DescribeLocationsRequest(*directconnect.DescribeLocationsInput) (*request.Request, *directconnect.DescribeLocationsOutput) + DescribeRouterConfiguration(*directconnect.DescribeRouterConfigurationInput) (*directconnect.DescribeRouterConfigurationOutput, error) + DescribeRouterConfigurationWithContext(aws.Context, *directconnect.DescribeRouterConfigurationInput, ...request.Option) (*directconnect.DescribeRouterConfigurationOutput, error) + DescribeRouterConfigurationRequest(*directconnect.DescribeRouterConfigurationInput) (*request.Request, *directconnect.DescribeRouterConfigurationOutput) + DescribeTags(*directconnect.DescribeTagsInput) (*directconnect.DescribeTagsOutput, error) DescribeTagsWithContext(aws.Context, *directconnect.DescribeTagsInput, ...request.Option) (*directconnect.DescribeTagsOutput, error) DescribeTagsRequest(*directconnect.DescribeTagsInput) (*request.Request, *directconnect.DescribeTagsOutput) @@ -284,6 +296,10 @@ type DirectConnectAPI interface { UpdateConnectionWithContext(aws.Context, *directconnect.UpdateConnectionInput, ...request.Option) (*directconnect.UpdateConnectionOutput, error) UpdateConnectionRequest(*directconnect.UpdateConnectionInput) (*request.Request, *directconnect.UpdateConnectionOutput) + UpdateDirectConnectGateway(*directconnect.UpdateDirectConnectGatewayInput) (*directconnect.UpdateDirectConnectGatewayOutput, error) + UpdateDirectConnectGatewayWithContext(aws.Context, *directconnect.UpdateDirectConnectGatewayInput, ...request.Option) (*directconnect.UpdateDirectConnectGatewayOutput, error) + UpdateDirectConnectGatewayRequest(*directconnect.UpdateDirectConnectGatewayInput) (*request.Request, *directconnect.UpdateDirectConnectGatewayOutput) + UpdateDirectConnectGatewayAssociation(*directconnect.UpdateDirectConnectGatewayAssociationInput) (*directconnect.UpdateDirectConnectGatewayAssociationOutput, error) UpdateDirectConnectGatewayAssociationWithContext(aws.Context, *directconnect.UpdateDirectConnectGatewayAssociationInput, ...request.Option) (*directconnect.UpdateDirectConnectGatewayAssociationOutput, error) UpdateDirectConnectGatewayAssociationRequest(*directconnect.UpdateDirectConnectGatewayAssociationInput) (*request.Request, *directconnect.UpdateDirectConnectGatewayAssociationOutput) diff --git a/service/directconnect/doc.go b/service/directconnect/doc.go index 47a5c5d099..27611b650b 100644 --- a/service/directconnect/doc.go +++ b/service/directconnect/doc.go @@ -6,12 +6,12 @@ // Direct Connect links your internal network to an Direct Connect location // over a standard Ethernet fiber-optic cable. One end of the cable is connected // to your router, the other to an Direct Connect router. With this connection -// in place, you can create virtual interfaces directly to the Cloud (for example, -// to Amazon EC2 and Amazon S3) and to Amazon VPC, bypassing Internet service -// providers in your network path. A connection provides access to all Regions -// except the China (Beijing) and (China) Ningxia Regions. Amazon Web Services -// resources in the China Regions can only be accessed through locations associated -// with those Regions. +// in place, you can create virtual interfaces directly to the Amazon Web Services +// Cloud (for example, to Amazon EC2 and Amazon S3) and to Amazon VPC, bypassing +// Internet service providers in your network path. A connection provides access +// to all Amazon Web Services Regions except the China (Beijing) and (China) +// Ningxia Regions. Amazon Web Services resources in the China Regions can only +// be accessed through locations associated with those Regions. // // See https://docs.aws.amazon.com/goto/WebAPI/directconnect-2012-10-25 for more information on this service. // diff --git a/service/mediaconvert/api.go b/service/mediaconvert/api.go index 8087215027..2c84e56c9f 100644 --- a/service/mediaconvert/api.go +++ b/service/mediaconvert/api.go @@ -4895,147 +4895,148 @@ func (s *BadRequestException) RequestID() string { return s.RespMetadata.RequestID } -// Settings related to burn-in captions. Set up burn-in captions in the same -// output as your video. For more information, see https://docs.aws.amazon.com/mediaconvert/latest/ug/burn-in-output-captions.html. +// Burn-in is a captions delivery method, rather than a captions format. Burn-in +// writes the captions directly on your video frames, replacing pixels of video +// content with the captions. Set up burn-in captions in the same output as +// your video. For more information, see https://docs.aws.amazon.com/mediaconvert/latest/ug/burn-in-output-captions.html. // When you work directly in your JSON job specification, include this object // and any required children when you set destinationType to BURN_IN. type BurninDestinationSettings struct { _ struct{} `type:"structure"` - // If no explicit x_position or y_position is provided, setting alignment to - // centered will place the captions at the bottom center of the output. Similarly, - // setting a left alignment will align captions to the bottom left of the output. - // If x and y positions are given in conjunction with the alignment parameter, - // the font will be justified (either left or centered) relative to those coordinates. - // This option is not valid for source captions that are STL, 608/embedded or - // teletext. These source settings are already pre-defined by the caption stream. - // All burn-in and DVB-Sub font settings must match. + // Specify the alignment of your captions. If no explicit x_position is provided, + // setting alignment to centered will placethe captions at the bottom center + // of the output. Similarly, setting a left alignment willalign captions to + // the bottom left of the output. If x and y positions are given in conjunction + // with the alignment parameter, the font will be justified (either left or + // centered) relative to those coordinates. Alignment *string `locationName:"alignment" type:"string" enum:"BurninSubtitleAlignment"` - // Ignore this setting unless your input captions are STL, any type of 608, - // teletext, or TTML, and your output captions are burned in. Specify how the - // service applies the color specified in the setting Font color (BurninSubtitleFontColor). - // By default, this color is white. When you choose WHITE_TEXT_ONLY, the service - // uses the specified font color only for text that is white in the input. When - // you choose ALL_TEXT, the service uses the specified font color for all output - // captions text. If you leave both settings at their default value, your output - // font color is the same as your input font color. + // Ignore this setting unless Style passthrough (StylePassthrough) is set to + // Enabled and Font color (FontColor) set to Black, Yellow, Red, Green, Blue, + // or Hex. Use Apply font color (ApplyFontColor) for additional font color controls. + // When you choose White text only (WHITE_TEXT_ONLY), or leave blank, your font + // color setting only applies to white text in your input captions. For example, + // if your font color setting is Yellow, and your input captions have red and + // white text, your output captions will have red and yellow text. When you + // choose ALL_TEXT, your font color setting applies to all of your output captions + // text. ApplyFontColor *string `locationName:"applyFontColor" type:"string" enum:"BurninSubtitleApplyFontColor"` - // Specifies the color of the rectangle behind the captions.All burn-in and - // DVB-Sub font settings must match. + // Specify the color of the rectangle behind the captions. Leave background + // color (BackgroundColor) blank and set Style passthrough (StylePassthrough) + // to enabled to use the background color data from your input captions, if + // present. Within your job settings, all of your DVB-Sub settings must be identical. BackgroundColor *string `locationName:"backgroundColor" type:"string" enum:"BurninSubtitleBackgroundColor"` - // Specifies the opacity of the background rectangle. 255 is opaque; 0 is transparent. - // Leaving this parameter blank is equivalent to setting it to 0 (transparent). - // All burn-in and DVB-Sub font settings must match. + // Specify the opacity of the background rectangle. Enter a value from 0 to + // 255, where 0 is transparent and 255 is opaque. If Style passthrough (StylePassthrough) + // is set to enabled, leave blank to pass through the background style information + // in your input captions to your output captions. If Style passthrough is set + // to disabled, leave blank to use a value of 0 and remove all backgrounds from + // your output captions. BackgroundOpacity *int64 `locationName:"backgroundOpacity" type:"integer"` // Specify the font that you want the service to use for your burn in captions // when your input captions specify a font that MediaConvert doesn't support. - // When you keep the default value, Best match (BEST_MATCH), MediaConvert uses - // a supported font that most closely matches the font that your input captions - // specify. When there are multiple unsupported fonts in your input captions, - // MediaConvert matches each font with the supported font that matches best. - // When you explicitly choose a replacement font, MediaConvert uses that font - // to replace all unsupported fonts from your input. + // When you set Fallback font (FallbackFont) to best match (BEST_MATCH), or + // leave blank, MediaConvert uses a supported font that most closely matches + // the font that your input captions specify. When there are multiple unsupported + // fonts in your input captions, MediaConvert matches each font with the supported + // font that matches best. When you explicitly choose a replacement font, MediaConvert + // uses that font to replace all unsupported fonts from your input. FallbackFont *string `locationName:"fallbackFont" type:"string" enum:"BurninSubtitleFallbackFont"` - // Specifies the color of the burned-in captions. This option is not valid for - // source captions that are STL, 608/embedded or teletext. These source settings - // are already pre-defined by the caption stream. All burn-in and DVB-Sub font - // settings must match. + // Specify the color of the burned-in captions text. Leave Font color (FontColor) + // blank and set Style passthrough (StylePassthrough) to enabled to use the + // font color data from your input captions, if present. FontColor *string `locationName:"fontColor" type:"string" enum:"BurninSubtitleFontColor"` - // Specifies the opacity of the burned-in captions. 255 is opaque; 0 is transparent.All - // burn-in and DVB-Sub font settings must match. + // Specify the opacity of the burned-in captions. 255 is opaque; 0 is transparent. FontOpacity *int64 `locationName:"fontOpacity" type:"integer"` - // Font resolution in DPI (dots per inch); default is 96 dpi.All burn-in and - // DVB-Sub font settings must match. + // Specify the Font resolution (FontResolution) in DPI (dots per inch). FontResolution *int64 `locationName:"fontResolution" min:"96" type:"integer"` - // Provide the font script, using an ISO 15924 script code, if the LanguageCode - // is not sufficient for determining the script type. Where LanguageCode or - // CustomLanguageCode is sufficient, use "AUTOMATIC" or leave unset. This is - // used to help determine the appropriate font for rendering burn-in captions. + // Set Font script (FontScript) to Automatically determined (AUTOMATIC), or + // leave blank, to automatically determine the font script in your input captions. + // Otherwise, set to Simplified Chinese (HANS) or Traditional Chinese (HANT) + // if your input font script uses Simplified or Traditional Chinese. FontScript *string `locationName:"fontScript" type:"string" enum:"FontScript"` - // A positive integer indicates the exact font size in points. Set to 0 for - // automatic font size selection. All burn-in and DVB-Sub font settings must - // match. + // Specify the Font size (FontSize) in pixels. Must be a positive integer. Set + // to 0, or leave blank, for automatic font size. FontSize *int64 `locationName:"fontSize" type:"integer"` - // Ignore this setting unless your BurninSubtitleFontColor setting is HEX. Format - // is six or eight hexidecimal digits, representing the red, green, and blue - // components, with the two extra digits used for an optional alpha value. For - // example a value of 1122AABB is a red value of 0x11, a green value of 0x22, - // a blue value of 0xAA, and an alpha value of 0xBB. + // Ignore this setting unless your Font color is set to Hex. Enter either six + // or eight hexidecimal digits, representing red, green, and blue, with two + // optional extra digits for alpha. For example a value of 1122AABB is a red + // value of 0x11, a green value of 0x22, a blue value of 0xAA, and an alpha + // value of 0xBB. HexFontColor *string `locationName:"hexFontColor" min:"6" type:"string"` - // Specifies font outline color. This option is not valid for source captions - // that are either 608/embedded or teletext. These source settings are already - // pre-defined by the caption stream. All burn-in and DVB-Sub font settings - // must match. + // Specify font outline color. Leave Outline color (OutlineColor) blank and + // set Style passthrough (StylePassthrough) to enabled to use the font outline + // color data from your input captions, if present. OutlineColor *string `locationName:"outlineColor" type:"string" enum:"BurninSubtitleOutlineColor"` - // Specifies font outline size in pixels. This option is not valid for source - // captions that are either 608/embedded or teletext. These source settings - // are already pre-defined by the caption stream. All burn-in and DVB-Sub font - // settings must match. + // Specify the Outline size (OutlineSize) of the caption text, in pixels. Leave + // Outline size blank and set Style passthrough (StylePassthrough) to enabled + // to use the outline size data from your input captions, if present. OutlineSize *int64 `locationName:"outlineSize" type:"integer"` - // Specifies the color of the shadow cast by the captions.All burn-in and DVB-Sub - // font settings must match. + // Specify the color of the shadow cast by the captions. Leave Shadow color + // (ShadowColor) blank and set Style passthrough (StylePassthrough) to enabled + // to use the shadow color data from your input captions, if present. ShadowColor *string `locationName:"shadowColor" type:"string" enum:"BurninSubtitleShadowColor"` - // Specifies the opacity of the shadow. 255 is opaque; 0 is transparent. Leaving - // this parameter blank is equivalent to setting it to 0 (transparent). All - // burn-in and DVB-Sub font settings must match. + // Specify the opacity of the shadow. Enter a value from 0 to 255, where 0 is + // transparent and 255 is opaque. If Style passthrough (StylePassthrough) is + // set to Enabled, leave Shadow opacity (ShadowOpacity) blank to pass through + // the shadow style information in your input captions to your output captions. + // If Style passthrough is set to disabled, leave blank to use a value of 0 + // and remove all shadows from your output captions. ShadowOpacity *int64 `locationName:"shadowOpacity" type:"integer"` - // Specifies the horizontal offset of the shadow relative to the captions in + // Specify the horizontal offset of the shadow, relative to the captions in // pixels. A value of -2 would result in a shadow offset 2 pixels to the left. - // All burn-in and DVB-Sub font settings must match. ShadowXOffset *int64 `locationName:"shadowXOffset" type:"integer"` - // Specifies the vertical offset of the shadow relative to the captions in pixels. - // A value of -2 would result in a shadow offset 2 pixels above the text. All - // burn-in and DVB-Sub font settings must match. + // Specify the vertical offset of the shadow relative to the captions in pixels. + // A value of -2 would result in a shadow offset 2 pixels above the text. Leave + // Shadow y-offset (ShadowYOffset) blank and set Style passthrough (StylePassthrough) + // to enabled to use the shadow y-offset data from your input captions, if present. ShadowYOffset *int64 `locationName:"shadowYOffset" type:"integer"` - // Ignore this setting unless your output captions are burned in. Choose which - // set of style and position values the service applies to your output captions. - // When you choose ENABLED, the service uses the input style and position information - // from your input. When you choose DISABLED, the service uses any style values - // that you specify in your output settings. If you don't specify values, the - // service uses default style and position values. When you choose DISABLED, - // the service ignores all style and position values from your input. + // Set Style passthrough (StylePassthrough) to ENABLED to use the available + // style, color, and position information from your input captions. MediaConvert + // uses default settings for any missing style and position information in your + // input captions. Set Style passthrough to DISABLED, or leave blank, to ignore + // the style and position information from your input captions and use default + // settings: white text with black outlining, bottom-center positioning, and + // automatic sizing. Whether you set Style passthrough to enabled or not, you + // can also choose to manually override any of the individual style and position + // settings. StylePassthrough *string `locationName:"stylePassthrough" type:"string" enum:"BurnInSubtitleStylePassthrough"` - // Only applies to jobs with input captions in Teletext or STL formats. Specify - // whether the spacing between letters in your captions is set by the captions - // grid or varies depending on letter width. Choose fixed grid to conform to - // the spacing specified in the captions file more accurately. Choose proportional - // to make the text easier to read if the captions are closed caption. + // Specify whether the text spacing (TeletextSpacing) in your captions is set + // by the captions grid, or varies depending on letter width. Choose fixed grid + // (FIXED_GRID) to conform to the spacing specified in the captions file more + // accurately. Choose proportional (PROPORTIONAL) to make the text easier to + // read for closed captions. TeletextSpacing *string `locationName:"teletextSpacing" type:"string" enum:"BurninSubtitleTeletextSpacing"` - // Specifies the horizontal position of the caption relative to the left side - // of the output in pixels. A value of 10 would result in the captions starting - // 10 pixels from the left of the output. If no explicit x_position is provided, - // the horizontal caption position will be determined by the alignment parameter. - // This option is not valid for source captions that are STL, 608/embedded or - // teletext. These source settings are already pre-defined by the caption stream. - // All burn-in and DVB-Sub font settings must match. + // Specify the horizontal position (XPosition) of the captions, relative to + // the left side of the output in pixels. A value of 10 would result in the + // captions starting 10 pixels from the left of the output. If no explicit x_position + // is provided, the horizontal caption position will be determined by the alignment + // parameter. XPosition *int64 `locationName:"xPosition" type:"integer"` - // Specifies the vertical position of the caption relative to the top of the - // output in pixels. A value of 10 would result in the captions starting 10 - // pixels from the top of the output. If no explicit y_position is provided, - // the caption will be positioned towards the bottom of the output. This option - // is not valid for source captions that are STL, 608/embedded or teletext. - // These source settings are already pre-defined by the caption stream. All - // burn-in and DVB-Sub font settings must match. + // Specify the vertical position (YPosition) of the captions, relative to the + // top of the output in pixels. A value of 10 would result in the captions starting + // 10 pixels from the top of the output. If no explicit y_position is provided, + // the caption will be positioned towards the bottom of the output. YPosition *int64 `locationName:"yPosition" type:"integer"` } @@ -5493,8 +5494,10 @@ func (s *CaptionDescriptionPreset) SetLanguageDescription(v string) *CaptionDesc type CaptionDestinationSettings struct { _ struct{} `type:"structure"` - // Settings related to burn-in captions. Set up burn-in captions in the same - // output as your video. For more information, see https://docs.aws.amazon.com/mediaconvert/latest/ug/burn-in-output-captions.html. + // Burn-in is a captions delivery method, rather than a captions format. Burn-in + // writes the captions directly on your video frames, replacing pixels of video + // content with the captions. Set up burn-in captions in the same output as + // your video. For more information, see https://docs.aws.amazon.com/mediaconvert/latest/ug/burn-in-output-captions.html. // When you work directly in your JSON job specification, include this object // and any required children when you set destinationType to BURN_IN. BurninDestinationSettings *BurninDestinationSettings `locationName:"burninDestinationSettings" type:"structure"` @@ -5539,7 +5542,11 @@ type CaptionDestinationSettings struct { // and any required children when you set destinationType to SCC. SccDestinationSettings *SccDestinationSettings `locationName:"sccDestinationSettings" type:"structure"` - // SRT Destination Settings + // Settings related to SRT captions. SRT is a sidecar format that holds captions + // in a file that is separate from the video container. Set up sidecar captions + // in the same output group, but different output from your video. When you + // work directly in your JSON job specification, include this object and any + // required children when you set destinationType to SRT. SrtDestinationSettings *SrtDestinationSettings `locationName:"srtDestinationSettings" type:"structure"` // Settings related to teletext captions. Set up teletext captions in the same @@ -5556,7 +5563,12 @@ type CaptionDestinationSettings struct { // and any required children when you set destinationType to TTML. TtmlDestinationSettings *TtmlDestinationSettings `locationName:"ttmlDestinationSettings" type:"structure"` - // WEBVTT Destination Settings + // Settings related to WebVTT captions. WebVTT is a sidecar format that holds + // captions in a file that is separate from the video container. Set up sidecar + // captions in the same output group, but different output from your video. + // For more information, see https://docs.aws.amazon.com/mediaconvert/latest/ug/ttml-and-webvtt-output-captions.html. + // When you work directly in your JSON job specification, include this object + // and any required children when you set destinationType to WebVTT. WebvttDestinationSettings *WebvttDestinationSettings `locationName:"webvttDestinationSettings" type:"structure"` } @@ -5753,10 +5765,10 @@ func (s *CaptionSelector) SetSourceSettings(v *CaptionSourceSettings) *CaptionSe // Ignore this setting unless your input captions format is SCC. To have the // service compensate for differing frame rates between your input captions // and input video, specify the frame rate of the captions file. Specify this -// value as a fraction, using the settings Framerate numerator (framerateNumerator) -// and Framerate denominator (framerateDenominator). For example, you might -// specify 24 / 1 for 24 fps, 25 / 1 for 25 fps, 24000 / 1001 for 23.976 fps, -// or 30000 / 1001 for 29.97 fps. +// value as a fraction. When you work directly in your JSON job specification, +// use the settings framerateNumerator and framerateDenominator. For example, +// you might specify 24 / 1 for 24 fps, 25 / 1 for 25 fps, 24000 / 1001 for +// 23.976 fps, or 30000 / 1001 for 29.97 fps. type CaptionSourceFramerate struct { _ struct{} `type:"structure"` @@ -9180,33 +9192,39 @@ func (s *DvbSdtSettings) SetServiceProviderName(v string) *DvbSdtSettings { type DvbSubDestinationSettings struct { _ struct{} `type:"structure"` - // If no explicit x_position or y_position is provided, setting alignment to - // centered will place the captions at the bottom center of the output. Similarly, - // setting a left alignment will align captions to the bottom left of the output. - // If x and y positions are given in conjunction with the alignment parameter, - // the font will be justified (either left or centered) relative to those coordinates. - // This option is not valid for source captions that are STL, 608/embedded or - // teletext. These source settings are already pre-defined by the caption stream. - // All burn-in and DVB-Sub font settings must match. + // Specify the alignment of your captions. If no explicit x_position is provided, + // setting alignment to centered will placethe captions at the bottom center + // of the output. Similarly, setting a left alignment willalign captions to + // the bottom left of the output. If x and y positions are given in conjunction + // with the alignment parameter, the font will be justified (either left or + // centered) relative to those coordinates. Within your job settings, all of + // your DVB-Sub settings must be identical. Alignment *string `locationName:"alignment" type:"string" enum:"DvbSubtitleAlignment"` - // Ignore this setting unless your input captions are STL, any type of 608, - // teletext, or TTML, and your output captions are DVB-SUB. Specify how the - // service applies the color specified in the setting Font color (DvbSubtitleFontColor). - // By default, this color is white. When you choose WHITE_TEXT_ONLY, the service - // uses the specified font color only for text that is white in the input. When - // you choose ALL_TEXT, the service uses the specified font color for all output - // captions text. If you leave both settings at their default value, your output - // font color is the same as your input font color. + // Ignore this setting unless Style Passthrough (StylePassthrough) is set to + // Enabled and Font color (FontColor) set to Black, Yellow, Red, Green, Blue, + // or Hex. Use Apply font color (ApplyFontColor) for additional font color controls. + // When you choose White text only (WHITE_TEXT_ONLY), or leave blank, your font + // color setting only applies to white text in your input captions. For example, + // if your font color setting is Yellow, and your input captions have red and + // white text, your output captions will have red and yellow text. When you + // choose ALL_TEXT, your font color setting applies to all of your output captions + // text. ApplyFontColor *string `locationName:"applyFontColor" type:"string" enum:"DvbSubtitleApplyFontColor"` - // Specifies the color of the rectangle behind the captions.All burn-in and - // DVB-Sub font settings must match. + // Specify the color of the rectangle behind the captions. Leave background + // color (BackgroundColor) blank and set Style passthrough (StylePassthrough) + // to enabled to use the background color data from your input captions, if + // present. BackgroundColor *string `locationName:"backgroundColor" type:"string" enum:"DvbSubtitleBackgroundColor"` - // Specifies the opacity of the background rectangle. 255 is opaque; 0 is transparent. - // Leaving this parameter blank is equivalent to setting it to 0 (transparent). - // All burn-in and DVB-Sub font settings must match. + // Specify the opacity of the background rectangle. Enter a value from 0 to + // 255, where 0 is transparent and 255 is opaque. If Style passthrough (StylePassthrough) + // is set to enabled, leave blank to pass through the background style information + // in your input captions to your output captions. If Style passthrough is set + // to disabled, leave blank to use a value of 0 and remove all backgrounds from + // your output captions. Within your job settings, all of your DVB-Sub settings + // must be identical. BackgroundOpacity *int64 `locationName:"backgroundOpacity" type:"integer"` // Specify how MediaConvert handles the display definition segment (DDS). Keep @@ -9249,37 +9267,38 @@ type DvbSubDestinationSettings struct { // Specify the font that you want the service to use for your burn in captions // when your input captions specify a font that MediaConvert doesn't support. - // When you keep the default value, Best match (BEST_MATCH), MediaConvert uses - // a supported font that most closely matches the font that your input captions - // specify. When there are multiple unsupported fonts in your input captions, - // MediaConvert matches each font with the supported font that matches best. - // When you explicitly choose a replacement font, MediaConvert uses that font - // to replace all unsupported fonts from your input. + // When you set Fallback font (FallbackFont) to best match (BEST_MATCH), or + // leave blank, MediaConvert uses a supported font that most closely matches + // the font that your input captions specify. When there are multiple unsupported + // fonts in your input captions, MediaConvert matches each font with the supported + // font that matches best. When you explicitly choose a replacement font, MediaConvert + // uses that font to replace all unsupported fonts from your input. FallbackFont *string `locationName:"fallbackFont" type:"string" enum:"DvbSubSubtitleFallbackFont"` - // Specifies the color of the DVB-SUB captions. This option is not valid for - // source captions that are STL, 608/embedded or teletext. These source settings - // are already pre-defined by the caption stream. All burn-in and DVB-Sub font - // settings must match. + // Specify the color of the captions text. Leave Font color (FontColor) blank + // and set Style passthrough (StylePassthrough) to enabled to use the font color + // data from your input captions, if present. Within your job settings, all + // of your DVB-Sub settings must be identical. FontColor *string `locationName:"fontColor" type:"string" enum:"DvbSubtitleFontColor"` - // Specifies the opacity of the burned-in captions. 255 is opaque; 0 is transparent.All - // burn-in and DVB-Sub font settings must match. + // Specify the opacity of the burned-in captions. 255 is opaque; 0 is transparent.Within + // your job settings, all of your DVB-Sub settings must be identical. FontOpacity *int64 `locationName:"fontOpacity" type:"integer"` - // Font resolution in DPI (dots per inch); default is 96 dpi.All burn-in and - // DVB-Sub font settings must match. + // Specify the Font resolution (FontResolution) in DPI (dots per inch).Within + // your job settings, all of your DVB-Sub settings must be identical. FontResolution *int64 `locationName:"fontResolution" min:"96" type:"integer"` - // Provide the font script, using an ISO 15924 script code, if the LanguageCode - // is not sufficient for determining the script type. Where LanguageCode or - // CustomLanguageCode is sufficient, use "AUTOMATIC" or leave unset. This is - // used to help determine the appropriate font for rendering DVB-Sub captions. + // Set Font script (FontScript) to Automatically determined (AUTOMATIC), or + // leave blank, to automatically determine the font script in your input captions. + // Otherwise, set to Simplified Chinese (HANS) or Traditional Chinese (HANT) + // if your input font script uses Simplified or Traditional Chinese. Within + // your job settings, all of your DVB-Sub settings must be identical. FontScript *string `locationName:"fontScript" type:"string" enum:"FontScript"` - // A positive integer indicates the exact font size in points. Set to 0 for - // automatic font size selection. All burn-in and DVB-Sub font settings must - // match. + // Specify the Font size (FontSize) in pixels. Must be a positive integer. Set + // to 0, or leave blank, for automatic font size. Within your job settings, + // all of your DVB-Sub settings must be identical. FontSize *int64 `locationName:"fontSize" type:"integer"` // Specify the height, in pixels, of this set of DVB-Sub captions. The default @@ -9288,51 +9307,61 @@ type DvbSubDestinationSettings struct { // and DVB-Sub font settings must match. Height *int64 `locationName:"height" min:"1" type:"integer"` - // Ignore this setting unless your DvbSubtitleFontColor setting is HEX. Format - // is six or eight hexidecimal digits, representing the red, green, and blue - // components, with the two extra digits used for an optional alpha value. For - // example a value of 1122AABB is a red value of 0x11, a green value of 0x22, - // a blue value of 0xAA, and an alpha value of 0xBB. + // Ignore this setting unless your Font color is set to Hex. Enter either six + // or eight hexidecimal digits, representing red, green, and blue, with two + // optional extra digits for alpha. For example a value of 1122AABB is a red + // value of 0x11, a green value of 0x22, a blue value of 0xAA, and an alpha + // value of 0xBB. HexFontColor *string `locationName:"hexFontColor" min:"6" type:"string"` - // Specifies font outline color. This option is not valid for source captions - // that are either 608/embedded or teletext. These source settings are already - // pre-defined by the caption stream. All burn-in and DVB-Sub font settings - // must match. + // Specify font outline color. Leave Outline color (OutlineColor) blank and + // set Style passthrough (StylePassthrough) to enabled to use the font outline + // color data from your input captions, if present. Within your job settings, + // all of your DVB-Sub settings must be identical. OutlineColor *string `locationName:"outlineColor" type:"string" enum:"DvbSubtitleOutlineColor"` - // Specifies font outline size in pixels. This option is not valid for source - // captions that are either 608/embedded or teletext. These source settings - // are already pre-defined by the caption stream. All burn-in and DVB-Sub font - // settings must match. + // Specify the Outline size (OutlineSize) of the caption text, in pixels. Leave + // Outline size blank and set Style passthrough (StylePassthrough) to enabled + // to use the outline size data from your input captions, if present. Within + // your job settings, all of your DVB-Sub settings must be identical. OutlineSize *int64 `locationName:"outlineSize" type:"integer"` - // Specifies the color of the shadow cast by the captions.All burn-in and DVB-Sub - // font settings must match. + // Specify the color of the shadow cast by the captions. Leave Shadow color + // (ShadowColor) blank and set Style passthrough (StylePassthrough) to enabled + // to use the shadow color data from your input captions, if present. Within + // your job settings, all of your DVB-Sub settings must be identical. ShadowColor *string `locationName:"shadowColor" type:"string" enum:"DvbSubtitleShadowColor"` - // Specifies the opacity of the shadow. 255 is opaque; 0 is transparent. Leaving - // this parameter blank is equivalent to setting it to 0 (transparent). All - // burn-in and DVB-Sub font settings must match. + // Specify the opacity of the shadow. Enter a value from 0 to 255, where 0 is + // transparent and 255 is opaque. If Style passthrough (StylePassthrough) is + // set to Enabled, leave Shadow opacity (ShadowOpacity) blank to pass through + // the shadow style information in your input captions to your output captions. + // If Style passthrough is set to disabled, leave blank to use a value of 0 + // and remove all shadows from your output captions. Within your job settings, + // all of your DVB-Sub settings must be identical. ShadowOpacity *int64 `locationName:"shadowOpacity" type:"integer"` - // Specifies the horizontal offset of the shadow relative to the captions in + // Specify the horizontal offset of the shadow, relative to the captions in // pixels. A value of -2 would result in a shadow offset 2 pixels to the left. - // All burn-in and DVB-Sub font settings must match. + // Within your job settings, all of your DVB-Sub settings must be identical. ShadowXOffset *int64 `locationName:"shadowXOffset" type:"integer"` - // Specifies the vertical offset of the shadow relative to the captions in pixels. - // A value of -2 would result in a shadow offset 2 pixels above the text. All - // burn-in and DVB-Sub font settings must match. + // Specify the vertical offset of the shadow relative to the captions in pixels. + // A value of -2 would result in a shadow offset 2 pixels above the text. Leave + // Shadow y-offset (ShadowYOffset) blank and set Style passthrough (StylePassthrough) + // to enabled to use the shadow y-offset data from your input captions, if present. + // Within your job settings, all of your DVB-Sub settings must be identical. ShadowYOffset *int64 `locationName:"shadowYOffset" type:"integer"` - // Choose which set of style and position values the service applies to your - // output captions. When you choose ENABLED, the service uses the input style - // and position information from your input. When you choose DISABLED, the service - // uses any style values that you specify in your output settings. If you don't - // specify values, the service uses default style and position values. When - // you choose DISABLED, the service ignores all style and position values from - // your input. + // Set Style passthrough (StylePassthrough) to ENABLED to use the available + // style, color, and position information from your input captions. MediaConvert + // uses default settings for any missing style and position information in your + // input captions. Set Style passthrough to DISABLED, or leave blank, to ignore + // the style and position information from your input captions and use default + // settings: white text with black outlining, bottom-center positioning, and + // automatic sizing. Whether you set Style passthrough to enabled or not, you + // can also choose to manually override any of the individual style and position + // settings. StylePassthrough *string `locationName:"stylePassthrough" type:"string" enum:"DvbSubtitleStylePassthrough"` // Specify whether your DVB subtitles are standard or for hearing impaired. @@ -9340,11 +9369,12 @@ type DvbSubDestinationSettings struct { // dialogue. Choose standard if your subtitles include only dialogue. SubtitlingType *string `locationName:"subtitlingType" type:"string" enum:"DvbSubtitlingType"` - // Only applies to jobs with input captions in Teletext or STL formats. Specify - // whether the spacing between letters in your captions is set by the captions - // grid or varies depending on letter width. Choose fixed grid to conform to - // the spacing specified in the captions file more accurately. Choose proportional - // to make the text easier to read if the captions are closed caption. + // Specify whether the Text spacing (TextSpacing) in your captions is set by + // the captions grid, or varies depending on letter width. Choose fixed grid + // (FIXED_GRID) to conform to the spacing specified in the captions file more + // accurately. Choose proportional (PROPORTIONAL) to make the text easier to + // read for closed captions. Within your job settings, all of your DVB-Sub settings + // must be identical. TeletextSpacing *string `locationName:"teletextSpacing" type:"string" enum:"DvbSubtitleTeletextSpacing"` // Specify the width, in pixels, of this set of DVB-Sub captions. The default @@ -9353,22 +9383,19 @@ type DvbSubDestinationSettings struct { // and DVB-Sub font settings must match. Width *int64 `locationName:"width" min:"1" type:"integer"` - // Specifies the horizontal position of the caption relative to the left side - // of the output in pixels. A value of 10 would result in the captions starting - // 10 pixels from the left of the output. If no explicit x_position is provided, - // the horizontal caption position will be determined by the alignment parameter. - // This option is not valid for source captions that are STL, 608/embedded or - // teletext. These source settings are already pre-defined by the caption stream. - // All burn-in and DVB-Sub font settings must match. + // Specify the horizontal position (XPosition) of the captions, relative to + // the left side of the outputin pixels. A value of 10 would result in the captions + // starting 10 pixels from the left ofthe output. If no explicit x_position + // is provided, the horizontal caption position will bedetermined by the alignment + // parameter. Within your job settings, all of your DVB-Sub settings must be + // identical. XPosition *int64 `locationName:"xPosition" type:"integer"` - // Specifies the vertical position of the caption relative to the top of the - // output in pixels. A value of 10 would result in the captions starting 10 - // pixels from the top of the output. If no explicit y_position is provided, - // the caption will be positioned towards the bottom of the output. This option - // is not valid for source captions that are STL, 608/embedded or teletext. - // These source settings are already pre-defined by the caption stream. All - // burn-in and DVB-Sub font settings must match. + // Specify the vertical position (YPosition) of the captions, relative to the + // top of the output in pixels. A value of 10 would result in the captions starting + // 10 pixels from the top of the output. If no explicit y_position is provided, + // the caption will be positioned towards the bottom of the output. Within your + // job settings, all of your DVB-Sub settings must be identical. YPosition *int64 `locationName:"yPosition" type:"integer"` } @@ -10702,19 +10729,36 @@ type FileSourceSettings struct { // Ignore this setting unless your input captions format is SCC. To have the // service compensate for differing frame rates between your input captions // and input video, specify the frame rate of the captions file. Specify this - // value as a fraction, using the settings Framerate numerator (framerateNumerator) - // and Framerate denominator (framerateDenominator). For example, you might - // specify 24 / 1 for 24 fps, 25 / 1 for 25 fps, 24000 / 1001 for 23.976 fps, - // or 30000 / 1001 for 29.97 fps. + // value as a fraction. When you work directly in your JSON job specification, + // use the settings framerateNumerator and framerateDenominator. For example, + // you might specify 24 / 1 for 24 fps, 25 / 1 for 25 fps, 24000 / 1001 for + // 23.976 fps, or 30000 / 1001 for 29.97 fps. Framerate *CaptionSourceFramerate `locationName:"framerate" type:"structure"` // External caption file used for loading captions. Accepted file extensions // are 'scc', 'ttml', 'dfxp', 'stl', 'srt', 'xml', 'smi', 'webvtt', and 'vtt'. SourceFile *string `locationName:"sourceFile" min:"14" type:"string"` - // Specifies a time delta in seconds to offset the captions from the source - // file. + // Optional. Use this setting when you need to adjust the sync between your + // sidecar captions and your video. For more information, see https://docs.aws.amazon.com/mediaconvert/latest/ug/time-delta-use-cases.html. + // Enter a positive or negative number to modify the times in the captions file. + // For example, type 15 to add 15 seconds to all the times in the captions file. + // Type -5 to subtract 5 seconds from the times in the captions file. You can + // optionally specify your time delta in milliseconds instead of seconds. When + // you do so, set the related setting, Time delta units (TimeDeltaUnits) to + // Milliseconds (MILLISECONDS). Note that, when you specify a time delta for + // timecode-based caption sources, such as SCC and STL, and your time delta + // isn't a multiple of the input frame rate, MediaConvert snaps the captions + // to the nearest frame. For example, when your input video frame rate is 25 + // fps and you specify 1010ms for time delta, MediaConvert delays your captions + // by 1000 ms. TimeDelta *int64 `locationName:"timeDelta" type:"integer"` + + // When you use the setting Time delta (TimeDelta) to adjust the sync between + // your sidecar captions and your video, use this setting to specify the units + // for the delta that you specify. When you don't specify a value for Time delta + // units (TimeDeltaUnits), MediaConvert uses seconds by default. + TimeDeltaUnits *string `locationName:"timeDeltaUnits" type:"string" enum:"FileSourceTimeDeltaUnits"` } // String returns the string representation. @@ -10780,6 +10824,12 @@ func (s *FileSourceSettings) SetTimeDelta(v int64) *FileSourceSettings { return s } +// SetTimeDeltaUnits sets the TimeDeltaUnits field's value. +func (s *FileSourceSettings) SetTimeDeltaUnits(v string) *FileSourceSettings { + s.TimeDeltaUnits = &v + return s +} + type ForbiddenException struct { _ struct{} `type:"structure"` RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"` @@ -21976,13 +22026,20 @@ func (s *SpekeKeyProviderCmaf) SetUrl(v string) *SpekeKeyProviderCmaf { return s } -// SRT Destination Settings +// Settings related to SRT captions. SRT is a sidecar format that holds captions +// in a file that is separate from the video container. Set up sidecar captions +// in the same output group, but different output from your video. When you +// work directly in your JSON job specification, include this object and any +// required children when you set destinationType to SRT. type SrtDestinationSettings struct { _ struct{} `type:"structure"` - // Choose Enabled (ENABLED) to have MediaConvert use the font style, color, - // and position information from the captions source in the input. Keep the - // default value, Disabled (DISABLED), for simplified output captions. + // Set Style passthrough (StylePassthrough) to ENABLED to use the available + // style, color, and position information from your input captions. MediaConvert + // uses default settings for any missing style and position information in your + // input captions. Set Style passthrough to DISABLED, or leave blank, to ignore + // the style and position information from your input captions and use simplified + // output captions. StylePassthrough *string `locationName:"stylePassthrough" type:"string" enum:"SrtStylePassthrough"` } @@ -24089,16 +24146,15 @@ type VideoSelector struct { // rotation metadata. Rotate *string `locationName:"rotate" type:"string" enum:"InputRotate"` - // Use this setting when your input video codec is AVC-Intra. Ignore this setting - // for all other inputs. If the sample range metadata in your input video is - // accurate, or if you don't know about sample range, keep the default value, - // Follow (FOLLOW), for this setting. When you do, the service automatically - // detects your input sample range. If your input video has metadata indicating - // the wrong sample range, specify the accurate sample range here. When you - // do, MediaConvert ignores any sample range information in the input metadata. - // Regardless of whether MediaConvert uses the input sample range or the sample - // range that you specify, MediaConvert uses the sample range for transcoding - // and also writes it to the output metadata. + // If the sample range metadata in your input video is accurate, or if you don't + // know about sample range, keep the default value, Follow (FOLLOW), for this + // setting. When you do, the service automatically detects your input sample + // range. If your input video has metadata indicating the wrong sample range, + // specify the accurate sample range here. When you do, MediaConvert ignores + // any sample range information in the input metadata. Regardless of whether + // MediaConvert uses the input sample range or the sample range that you specify, + // MediaConvert uses the sample range for transcoding and also writes it to + // the output metadata. SampleRange *string `locationName:"sampleRange" type:"string" enum:"InputSampleRange"` } @@ -24783,13 +24839,21 @@ func (s *WavSettings) SetSampleRate(v int64) *WavSettings { return s } -// WEBVTT Destination Settings +// Settings related to WebVTT captions. WebVTT is a sidecar format that holds +// captions in a file that is separate from the video container. Set up sidecar +// captions in the same output group, but different output from your video. +// For more information, see https://docs.aws.amazon.com/mediaconvert/latest/ug/ttml-and-webvtt-output-captions.html. +// When you work directly in your JSON job specification, include this object +// and any required children when you set destinationType to WebVTT. type WebvttDestinationSettings struct { _ struct{} `type:"structure"` - // Choose Enabled (ENABLED) to have MediaConvert use the font style, color, - // and position information from the captions source in the input. Keep the - // default value, Disabled (DISABLED), for simplified output captions. + // Set Style passthrough (StylePassthrough) to ENABLED to use the available + // style, color, and position information from your input captions. MediaConvert + // uses default settings for any missing style and position information in your + // input captions. Set Style passthrough to DISABLED, or leave blank, to ignore + // the style and position information from your input captions and use simplified + // output captions. StylePassthrough *string `locationName:"stylePassthrough" type:"string" enum:"WebvttStylePassthrough"` } @@ -26791,13 +26855,15 @@ func BillingTagsSource_Values() []string { } } -// Ignore this setting unless your output captions are burned in. Choose which -// set of style and position values the service applies to your output captions. -// When you choose ENABLED, the service uses the input style and position information -// from your input. When you choose DISABLED, the service uses any style values -// that you specify in your output settings. If you don't specify values, the -// service uses default style and position values. When you choose DISABLED, -// the service ignores all style and position values from your input. +// Set Style passthrough (StylePassthrough) to ENABLED to use the available +// style, color, and position information from your input captions. MediaConvert +// uses default settings for any missing style and position information in your +// input captions. Set Style passthrough to DISABLED, or leave blank, to ignore +// the style and position information from your input captions and use default +// settings: white text with black outlining, bottom-center positioning, and +// automatic sizing. Whether you set Style passthrough to enabled or not, you +// can also choose to manually override any of the individual style and position +// settings. const ( // BurnInSubtitleStylePassthroughEnabled is a BurnInSubtitleStylePassthrough enum value BurnInSubtitleStylePassthroughEnabled = "ENABLED" @@ -26814,14 +26880,12 @@ func BurnInSubtitleStylePassthrough_Values() []string { } } -// If no explicit x_position or y_position is provided, setting alignment to -// centered will place the captions at the bottom center of the output. Similarly, -// setting a left alignment will align captions to the bottom left of the output. -// If x and y positions are given in conjunction with the alignment parameter, -// the font will be justified (either left or centered) relative to those coordinates. -// This option is not valid for source captions that are STL, 608/embedded or -// teletext. These source settings are already pre-defined by the caption stream. -// All burn-in and DVB-Sub font settings must match. +// Specify the alignment of your captions. If no explicit x_position is provided, +// setting alignment to centered will placethe captions at the bottom center +// of the output. Similarly, setting a left alignment willalign captions to +// the bottom left of the output. If x and y positions are given in conjunction +// with the alignment parameter, the font will be justified (either left or +// centered) relative to those coordinates. const ( // BurninSubtitleAlignmentCentered is a BurninSubtitleAlignment enum value BurninSubtitleAlignmentCentered = "CENTERED" @@ -26842,14 +26906,15 @@ func BurninSubtitleAlignment_Values() []string { } } -// Ignore this setting unless your input captions are STL, any type of 608, -// teletext, or TTML, and your output captions are burned in. Specify how the -// service applies the color specified in the setting Font color (BurninSubtitleFontColor). -// By default, this color is white. When you choose WHITE_TEXT_ONLY, the service -// uses the specified font color only for text that is white in the input. When -// you choose ALL_TEXT, the service uses the specified font color for all output -// captions text. If you leave both settings at their default value, your output -// font color is the same as your input font color. +// Ignore this setting unless Style passthrough (StylePassthrough) is set to +// Enabled and Font color (FontColor) set to Black, Yellow, Red, Green, Blue, +// or Hex. Use Apply font color (ApplyFontColor) for additional font color controls. +// When you choose White text only (WHITE_TEXT_ONLY), or leave blank, your font +// color setting only applies to white text in your input captions. For example, +// if your font color setting is Yellow, and your input captions have red and +// white text, your output captions will have red and yellow text. When you +// choose ALL_TEXT, your font color setting applies to all of your output captions +// text. const ( // BurninSubtitleApplyFontColorWhiteTextOnly is a BurninSubtitleApplyFontColor enum value BurninSubtitleApplyFontColorWhiteTextOnly = "WHITE_TEXT_ONLY" @@ -26866,8 +26931,10 @@ func BurninSubtitleApplyFontColor_Values() []string { } } -// Specifies the color of the rectangle behind the captions.All burn-in and -// DVB-Sub font settings must match. +// Specify the color of the rectangle behind the captions. Leave background +// color (BackgroundColor) blank and set Style passthrough (StylePassthrough) +// to enabled to use the background color data from your input captions, if +// present. Within your job settings, all of your DVB-Sub settings must be identical. const ( // BurninSubtitleBackgroundColorNone is a BurninSubtitleBackgroundColor enum value BurninSubtitleBackgroundColorNone = "NONE" @@ -26894,12 +26961,12 @@ func BurninSubtitleBackgroundColor_Values() []string { // Specify the font that you want the service to use for your burn in captions // when your input captions specify a font that MediaConvert doesn't support. -// When you keep the default value, Best match (BEST_MATCH), MediaConvert uses -// a supported font that most closely matches the font that your input captions -// specify. When there are multiple unsupported fonts in your input captions, -// MediaConvert matches each font with the supported font that matches best. -// When you explicitly choose a replacement font, MediaConvert uses that font -// to replace all unsupported fonts from your input. +// When you set Fallback font (FallbackFont) to best match (BEST_MATCH), or +// leave blank, MediaConvert uses a supported font that most closely matches +// the font that your input captions specify. When there are multiple unsupported +// fonts in your input captions, MediaConvert matches each font with the supported +// font that matches best. When you explicitly choose a replacement font, MediaConvert +// uses that font to replace all unsupported fonts from your input. const ( // BurninSubtitleFallbackFontBestMatch is a BurninSubtitleFallbackFont enum value BurninSubtitleFallbackFontBestMatch = "BEST_MATCH" @@ -26928,10 +26995,9 @@ func BurninSubtitleFallbackFont_Values() []string { } } -// Specifies the color of the burned-in captions. This option is not valid for -// source captions that are STL, 608/embedded or teletext. These source settings -// are already pre-defined by the caption stream. All burn-in and DVB-Sub font -// settings must match. +// Specify the color of the burned-in captions text. Leave Font color (FontColor) +// blank and set Style passthrough (StylePassthrough) to enabled to use the +// font color data from your input captions, if present. const ( // BurninSubtitleFontColorWhite is a BurninSubtitleFontColor enum value BurninSubtitleFontColorWhite = "WHITE" @@ -26972,10 +27038,9 @@ func BurninSubtitleFontColor_Values() []string { } } -// Specifies font outline color. This option is not valid for source captions -// that are either 608/embedded or teletext. These source settings are already -// pre-defined by the caption stream. All burn-in and DVB-Sub font settings -// must match. +// Specify font outline color. Leave Outline color (OutlineColor) blank and +// set Style passthrough (StylePassthrough) to enabled to use the font outline +// color data from your input captions, if present. const ( // BurninSubtitleOutlineColorBlack is a BurninSubtitleOutlineColor enum value BurninSubtitleOutlineColorBlack = "BLACK" @@ -27012,8 +27077,9 @@ func BurninSubtitleOutlineColor_Values() []string { } } -// Specifies the color of the shadow cast by the captions.All burn-in and DVB-Sub -// font settings must match. +// Specify the color of the shadow cast by the captions. Leave Shadow color +// (ShadowColor) blank and set Style passthrough (StylePassthrough) to enabled +// to use the shadow color data from your input captions, if present. const ( // BurninSubtitleShadowColorNone is a BurninSubtitleShadowColor enum value BurninSubtitleShadowColorNone = "NONE" @@ -27038,11 +27104,11 @@ func BurninSubtitleShadowColor_Values() []string { } } -// Only applies to jobs with input captions in Teletext or STL formats. Specify -// whether the spacing between letters in your captions is set by the captions -// grid or varies depending on letter width. Choose fixed grid to conform to -// the spacing specified in the captions file more accurately. Choose proportional -// to make the text easier to read if the captions are closed caption. +// Specify whether the text spacing (TeletextSpacing) in your captions is set +// by the captions grid, or varies depending on letter width. Choose fixed grid +// (FIXED_GRID) to conform to the spacing specified in the captions file more +// accurately. Choose proportional (PROPORTIONAL) to make the text easier to +// read for closed captions. const ( // BurninSubtitleTeletextSpacingFixedGrid is a BurninSubtitleTeletextSpacing enum value BurninSubtitleTeletextSpacingFixedGrid = "FIXED_GRID" @@ -28311,12 +28377,12 @@ func DropFrameTimecode_Values() []string { // Specify the font that you want the service to use for your burn in captions // when your input captions specify a font that MediaConvert doesn't support. -// When you keep the default value, Best match (BEST_MATCH), MediaConvert uses -// a supported font that most closely matches the font that your input captions -// specify. When there are multiple unsupported fonts in your input captions, -// MediaConvert matches each font with the supported font that matches best. -// When you explicitly choose a replacement font, MediaConvert uses that font -// to replace all unsupported fonts from your input. +// When you set Fallback font (FallbackFont) to best match (BEST_MATCH), or +// leave blank, MediaConvert uses a supported font that most closely matches +// the font that your input captions specify. When there are multiple unsupported +// fonts in your input captions, MediaConvert matches each font with the supported +// font that matches best. When you explicitly choose a replacement font, MediaConvert +// uses that font to replace all unsupported fonts from your input. const ( // DvbSubSubtitleFallbackFontBestMatch is a DvbSubSubtitleFallbackFont enum value DvbSubSubtitleFallbackFontBestMatch = "BEST_MATCH" @@ -28345,14 +28411,13 @@ func DvbSubSubtitleFallbackFont_Values() []string { } } -// If no explicit x_position or y_position is provided, setting alignment to -// centered will place the captions at the bottom center of the output. Similarly, -// setting a left alignment will align captions to the bottom left of the output. -// If x and y positions are given in conjunction with the alignment parameter, -// the font will be justified (either left or centered) relative to those coordinates. -// This option is not valid for source captions that are STL, 608/embedded or -// teletext. These source settings are already pre-defined by the caption stream. -// All burn-in and DVB-Sub font settings must match. +// Specify the alignment of your captions. If no explicit x_position is provided, +// setting alignment to centered will placethe captions at the bottom center +// of the output. Similarly, setting a left alignment willalign captions to +// the bottom left of the output. If x and y positions are given in conjunction +// with the alignment parameter, the font will be justified (either left or +// centered) relative to those coordinates. Within your job settings, all of +// your DVB-Sub settings must be identical. const ( // DvbSubtitleAlignmentCentered is a DvbSubtitleAlignment enum value DvbSubtitleAlignmentCentered = "CENTERED" @@ -28373,14 +28438,15 @@ func DvbSubtitleAlignment_Values() []string { } } -// Ignore this setting unless your input captions are STL, any type of 608, -// teletext, or TTML, and your output captions are DVB-SUB. Specify how the -// service applies the color specified in the setting Font color (DvbSubtitleFontColor). -// By default, this color is white. When you choose WHITE_TEXT_ONLY, the service -// uses the specified font color only for text that is white in the input. When -// you choose ALL_TEXT, the service uses the specified font color for all output -// captions text. If you leave both settings at their default value, your output -// font color is the same as your input font color. +// Ignore this setting unless Style Passthrough (StylePassthrough) is set to +// Enabled and Font color (FontColor) set to Black, Yellow, Red, Green, Blue, +// or Hex. Use Apply font color (ApplyFontColor) for additional font color controls. +// When you choose White text only (WHITE_TEXT_ONLY), or leave blank, your font +// color setting only applies to white text in your input captions. For example, +// if your font color setting is Yellow, and your input captions have red and +// white text, your output captions will have red and yellow text. When you +// choose ALL_TEXT, your font color setting applies to all of your output captions +// text. const ( // DvbSubtitleApplyFontColorWhiteTextOnly is a DvbSubtitleApplyFontColor enum value DvbSubtitleApplyFontColorWhiteTextOnly = "WHITE_TEXT_ONLY" @@ -28397,8 +28463,10 @@ func DvbSubtitleApplyFontColor_Values() []string { } } -// Specifies the color of the rectangle behind the captions.All burn-in and -// DVB-Sub font settings must match. +// Specify the color of the rectangle behind the captions. Leave background +// color (BackgroundColor) blank and set Style passthrough (StylePassthrough) +// to enabled to use the background color data from your input captions, if +// present. const ( // DvbSubtitleBackgroundColorNone is a DvbSubtitleBackgroundColor enum value DvbSubtitleBackgroundColorNone = "NONE" @@ -28423,10 +28491,10 @@ func DvbSubtitleBackgroundColor_Values() []string { } } -// Specifies the color of the DVB-SUB captions. This option is not valid for -// source captions that are STL, 608/embedded or teletext. These source settings -// are already pre-defined by the caption stream. All burn-in and DVB-Sub font -// settings must match. +// Specify the color of the captions text. Leave Font color (FontColor) blank +// and set Style passthrough (StylePassthrough) to enabled to use the font color +// data from your input captions, if present. Within your job settings, all +// of your DVB-Sub settings must be identical. const ( // DvbSubtitleFontColorWhite is a DvbSubtitleFontColor enum value DvbSubtitleFontColorWhite = "WHITE" @@ -28467,10 +28535,10 @@ func DvbSubtitleFontColor_Values() []string { } } -// Specifies font outline color. This option is not valid for source captions -// that are either 608/embedded or teletext. These source settings are already -// pre-defined by the caption stream. All burn-in and DVB-Sub font settings -// must match. +// Specify font outline color. Leave Outline color (OutlineColor) blank and +// set Style passthrough (StylePassthrough) to enabled to use the font outline +// color data from your input captions, if present. Within your job settings, +// all of your DVB-Sub settings must be identical. const ( // DvbSubtitleOutlineColorBlack is a DvbSubtitleOutlineColor enum value DvbSubtitleOutlineColorBlack = "BLACK" @@ -28507,8 +28575,10 @@ func DvbSubtitleOutlineColor_Values() []string { } } -// Specifies the color of the shadow cast by the captions.All burn-in and DVB-Sub -// font settings must match. +// Specify the color of the shadow cast by the captions. Leave Shadow color +// (ShadowColor) blank and set Style passthrough (StylePassthrough) to enabled +// to use the shadow color data from your input captions, if present. Within +// your job settings, all of your DVB-Sub settings must be identical. const ( // DvbSubtitleShadowColorNone is a DvbSubtitleShadowColor enum value DvbSubtitleShadowColorNone = "NONE" @@ -28533,13 +28603,15 @@ func DvbSubtitleShadowColor_Values() []string { } } -// Choose which set of style and position values the service applies to your -// output captions. When you choose ENABLED, the service uses the input style -// and position information from your input. When you choose DISABLED, the service -// uses any style values that you specify in your output settings. If you don't -// specify values, the service uses default style and position values. When -// you choose DISABLED, the service ignores all style and position values from -// your input. +// Set Style passthrough (StylePassthrough) to ENABLED to use the available +// style, color, and position information from your input captions. MediaConvert +// uses default settings for any missing style and position information in your +// input captions. Set Style passthrough to DISABLED, or leave blank, to ignore +// the style and position information from your input captions and use default +// settings: white text with black outlining, bottom-center positioning, and +// automatic sizing. Whether you set Style passthrough to enabled or not, you +// can also choose to manually override any of the individual style and position +// settings. const ( // DvbSubtitleStylePassthroughEnabled is a DvbSubtitleStylePassthrough enum value DvbSubtitleStylePassthroughEnabled = "ENABLED" @@ -28556,11 +28628,12 @@ func DvbSubtitleStylePassthrough_Values() []string { } } -// Only applies to jobs with input captions in Teletext or STL formats. Specify -// whether the spacing between letters in your captions is set by the captions -// grid or varies depending on letter width. Choose fixed grid to conform to -// the spacing specified in the captions file more accurately. Choose proportional -// to make the text easier to read if the captions are closed caption. +// Specify whether the Text spacing (TextSpacing) in your captions is set by +// the captions grid, or varies depending on letter width. Choose fixed grid +// (FIXED_GRID) to conform to the spacing specified in the captions file more +// accurately. Choose proportional (PROPORTIONAL) to make the text easier to +// read for closed captions. Within your job settings, all of your DVB-Sub settings +// must be identical. const ( // DvbSubtitleTeletextSpacingFixedGrid is a DvbSubtitleTeletextSpacing enum value DvbSubtitleTeletextSpacingFixedGrid = "FIXED_GRID" @@ -29309,6 +29382,26 @@ func FileSourceConvert608To708_Values() []string { } } +// When you use the setting Time delta (TimeDelta) to adjust the sync between +// your sidecar captions and your video, use this setting to specify the units +// for the delta that you specify. When you don't specify a value for Time delta +// units (TimeDeltaUnits), MediaConvert uses seconds by default. +const ( + // FileSourceTimeDeltaUnitsSeconds is a FileSourceTimeDeltaUnits enum value + FileSourceTimeDeltaUnitsSeconds = "SECONDS" + + // FileSourceTimeDeltaUnitsMilliseconds is a FileSourceTimeDeltaUnits enum value + FileSourceTimeDeltaUnitsMilliseconds = "MILLISECONDS" +) + +// FileSourceTimeDeltaUnits_Values returns all elements of the FileSourceTimeDeltaUnits enum +func FileSourceTimeDeltaUnits_Values() []string { + return []string{ + FileSourceTimeDeltaUnitsSeconds, + FileSourceTimeDeltaUnitsMilliseconds, + } +} + // Provide the font script, using an ISO 15924 script code, if the LanguageCode // is not sufficient for determining the script type. Where LanguageCode or // CustomLanguageCode is sufficient, use "AUTOMATIC" or leave unset. @@ -31378,16 +31471,15 @@ func InputRotate_Values() []string { } } -// Use this setting when your input video codec is AVC-Intra. Ignore this setting -// for all other inputs. If the sample range metadata in your input video is -// accurate, or if you don't know about sample range, keep the default value, -// Follow (FOLLOW), for this setting. When you do, the service automatically -// detects your input sample range. If your input video has metadata indicating -// the wrong sample range, specify the accurate sample range here. When you -// do, MediaConvert ignores any sample range information in the input metadata. -// Regardless of whether MediaConvert uses the input sample range or the sample -// range that you specify, MediaConvert uses the sample range for transcoding -// and also writes it to the output metadata. +// If the sample range metadata in your input video is accurate, or if you don't +// know about sample range, keep the default value, Follow (FOLLOW), for this +// setting. When you do, the service automatically detects your input sample +// range. If your input video has metadata indicating the wrong sample range, +// specify the accurate sample range here. When you do, MediaConvert ignores +// any sample range information in the input metadata. Regardless of whether +// MediaConvert uses the input sample range or the sample range that you specify, +// MediaConvert uses the sample range for transcoding and also writes it to +// the output metadata. const ( // InputSampleRangeFollow is a InputSampleRange enum value InputSampleRangeFollow = "FOLLOW" @@ -34427,9 +34519,12 @@ func SimulateReservedQueue_Values() []string { } } -// Choose Enabled (ENABLED) to have MediaConvert use the font style, color, -// and position information from the captions source in the input. Keep the -// default value, Disabled (DISABLED), for simplified output captions. +// Set Style passthrough (StylePassthrough) to ENABLED to use the available +// style, color, and position information from your input captions. MediaConvert +// uses default settings for any missing style and position information in your +// input captions. Set Style passthrough to DISABLED, or leave blank, to ignore +// the style and position information from your input captions and use simplified +// output captions. const ( // SrtStylePassthroughEnabled is a SrtStylePassthrough enum value SrtStylePassthroughEnabled = "ENABLED" @@ -35229,9 +35324,12 @@ func WavFormat_Values() []string { } } -// Choose Enabled (ENABLED) to have MediaConvert use the font style, color, -// and position information from the captions source in the input. Keep the -// default value, Disabled (DISABLED), for simplified output captions. +// Set Style passthrough (StylePassthrough) to ENABLED to use the available +// style, color, and position information from your input captions. MediaConvert +// uses default settings for any missing style and position information in your +// input captions. Set Style passthrough to DISABLED, or leave blank, to ignore +// the style and position information from your input captions and use simplified +// output captions. const ( // WebvttStylePassthroughEnabled is a WebvttStylePassthrough enum value WebvttStylePassthroughEnabled = "ENABLED" diff --git a/service/mediapackage/api.go b/service/mediapackage/api.go index e8065d8d20..c3faf89c17 100644 --- a/service/mediapackage/api.go +++ b/service/mediapackage/api.go @@ -4606,6 +4606,10 @@ type HlsPackage struct { // An HTTP Live Streaming (HLS) encryption configuration. Encryption *HlsEncryption `locationName:"encryption" type:"structure"` + // When enabled, MediaPackage passes through digital video broadcasting (DVB) + // subtitles into the output. + IncludeDvbSubtitles *bool `locationName:"includeDvbSubtitles" type:"boolean"` + // When enabled, an I-Frame only stream will be included in the output. IncludeIframeOnlyStream *bool `locationName:"includeIframeOnlyStream" type:"boolean"` @@ -4695,6 +4699,12 @@ func (s *HlsPackage) SetEncryption(v *HlsEncryption) *HlsPackage { return s } +// SetIncludeDvbSubtitles sets the IncludeDvbSubtitles field's value. +func (s *HlsPackage) SetIncludeDvbSubtitles(v bool) *HlsPackage { + s.IncludeDvbSubtitles = &v + return s +} + // SetIncludeIframeOnlyStream sets the IncludeIframeOnlyStream field's value. func (s *HlsPackage) SetIncludeIframeOnlyStream(v bool) *HlsPackage { s.IncludeIframeOnlyStream = &v diff --git a/service/mediapackagevod/api.go b/service/mediapackagevod/api.go index 18ee1f330a..370899f304 100644 --- a/service/mediapackagevod/api.go +++ b/service/mediapackagevod/api.go @@ -3799,6 +3799,10 @@ type HlsPackage struct { // HlsManifests is a required field HlsManifests []*HlsManifest `locationName:"hlsManifests" type:"list" required:"true"` + // When enabled, MediaPackage passes through digital video broadcasting (DVB) + // subtitles into the output. + IncludeDvbSubtitles *bool `locationName:"includeDvbSubtitles" type:"boolean"` + // Duration (in seconds) of each fragment. Actual fragments will berounded to // the nearest multiple of the source fragment duration. SegmentDurationSeconds *int64 `locationName:"segmentDurationSeconds" type:"integer"` @@ -3855,6 +3859,12 @@ func (s *HlsPackage) SetHlsManifests(v []*HlsManifest) *HlsPackage { return s } +// SetIncludeDvbSubtitles sets the IncludeDvbSubtitles field's value. +func (s *HlsPackage) SetIncludeDvbSubtitles(v bool) *HlsPackage { + s.IncludeDvbSubtitles = &v + return s +} + // SetSegmentDurationSeconds sets the SegmentDurationSeconds field's value. func (s *HlsPackage) SetSegmentDurationSeconds(v int64) *HlsPackage { s.SegmentDurationSeconds = &v diff --git a/service/panorama/api.go b/service/panorama/api.go new file mode 100644 index 0000000000..5d87fdaa5b --- /dev/null +++ b/service/panorama/api.go @@ -0,0 +1,10852 @@ +// Code generated by private/model/cli/gen-api/main.go. DO NOT EDIT. + +package panorama + +import ( + "fmt" + "time" + + "github.com/aws/aws-sdk-go/aws" + "github.com/aws/aws-sdk-go/aws/awsutil" + "github.com/aws/aws-sdk-go/aws/request" + "github.com/aws/aws-sdk-go/private/protocol" + "github.com/aws/aws-sdk-go/private/protocol/restjson" +) + +const opCreateApplicationInstance = "CreateApplicationInstance" + +// CreateApplicationInstanceRequest generates a "aws/request.Request" representing the +// client's request for the CreateApplicationInstance operation. The "output" return +// value will be populated with the request's response once the request completes +// successfully. +// +// Use "Send" method on the returned Request to send the API call to the service. +// the "output" return value is not valid until after Send returns without error. +// +// See CreateApplicationInstance for more information on using the CreateApplicationInstance +// API call, and error handling. +// +// This method is useful when you want to inject custom logic or configuration +// into the SDK's request lifecycle. Such as custom headers, or retry logic. +// +// +// // Example sending a request using the CreateApplicationInstanceRequest method. +// req, resp := client.CreateApplicationInstanceRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/panorama-2019-07-24/CreateApplicationInstance +func (c *Panorama) CreateApplicationInstanceRequest(input *CreateApplicationInstanceInput) (req *request.Request, output *CreateApplicationInstanceOutput) { + op := &request.Operation{ + Name: opCreateApplicationInstance, + HTTPMethod: "POST", + HTTPPath: "/application-instances", + } + + if input == nil { + input = &CreateApplicationInstanceInput{} + } + + output = &CreateApplicationInstanceOutput{} + req = c.newRequest(op, input, output) + return +} + +// CreateApplicationInstance API operation for AWS Panorama. +// +// Creates an application instance and deploys it to a device. +// +// Returns awserr.Error for service API and SDK errors. Use runtime type assertions +// with awserr.Error's Code and Message methods to get detailed information about +// the error. +// +// See the AWS API reference guide for AWS Panorama's +// API operation CreateApplicationInstance for usage and error information. +// +// Returned Error Types: +// * ValidationException +// The request contains an invalid parameter value. +// +// * InternalServerException +// An internal error occurred. +// +// * AccessDeniedException +// The requestor does not have permission to access the target action or resource. +// +// * ServiceQuotaExceededException +// The request would cause a limit to be exceeded. +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/panorama-2019-07-24/CreateApplicationInstance +func (c *Panorama) CreateApplicationInstance(input *CreateApplicationInstanceInput) (*CreateApplicationInstanceOutput, error) { + req, out := c.CreateApplicationInstanceRequest(input) + return out, req.Send() +} + +// CreateApplicationInstanceWithContext is the same as CreateApplicationInstance with the addition of +// the ability to pass a context and additional request options. +// +// See CreateApplicationInstance for details on how to use this API operation. +// +// The context must be non-nil and will be used for request cancellation. If +// the context is nil a panic will occur. In the future the SDK may create +// sub-contexts for http.Requests. See https://golang.org/pkg/context/ +// for more information on using Contexts. +func (c *Panorama) CreateApplicationInstanceWithContext(ctx aws.Context, input *CreateApplicationInstanceInput, opts ...request.Option) (*CreateApplicationInstanceOutput, error) { + req, out := c.CreateApplicationInstanceRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + +const opCreateJobForDevices = "CreateJobForDevices" + +// CreateJobForDevicesRequest generates a "aws/request.Request" representing the +// client's request for the CreateJobForDevices operation. The "output" return +// value will be populated with the request's response once the request completes +// successfully. +// +// Use "Send" method on the returned Request to send the API call to the service. +// the "output" return value is not valid until after Send returns without error. +// +// See CreateJobForDevices for more information on using the CreateJobForDevices +// API call, and error handling. +// +// This method is useful when you want to inject custom logic or configuration +// into the SDK's request lifecycle. Such as custom headers, or retry logic. +// +// +// // Example sending a request using the CreateJobForDevicesRequest method. +// req, resp := client.CreateJobForDevicesRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/panorama-2019-07-24/CreateJobForDevices +func (c *Panorama) CreateJobForDevicesRequest(input *CreateJobForDevicesInput) (req *request.Request, output *CreateJobForDevicesOutput) { + op := &request.Operation{ + Name: opCreateJobForDevices, + HTTPMethod: "POST", + HTTPPath: "/jobs", + } + + if input == nil { + input = &CreateJobForDevicesInput{} + } + + output = &CreateJobForDevicesOutput{} + req = c.newRequest(op, input, output) + return +} + +// CreateJobForDevices API operation for AWS Panorama. +// +// Creates a job to run on one or more devices. +// +// Returns awserr.Error for service API and SDK errors. Use runtime type assertions +// with awserr.Error's Code and Message methods to get detailed information about +// the error. +// +// See the AWS API reference guide for AWS Panorama's +// API operation CreateJobForDevices for usage and error information. +// +// Returned Error Types: +// * ConflictException +// The target resource is in use. +// +// * ValidationException +// The request contains an invalid parameter value. +// +// * InternalServerException +// An internal error occurred. +// +// * AccessDeniedException +// The requestor does not have permission to access the target action or resource. +// +// * ResourceNotFoundException +// The target resource was not found. +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/panorama-2019-07-24/CreateJobForDevices +func (c *Panorama) CreateJobForDevices(input *CreateJobForDevicesInput) (*CreateJobForDevicesOutput, error) { + req, out := c.CreateJobForDevicesRequest(input) + return out, req.Send() +} + +// CreateJobForDevicesWithContext is the same as CreateJobForDevices with the addition of +// the ability to pass a context and additional request options. +// +// See CreateJobForDevices for details on how to use this API operation. +// +// The context must be non-nil and will be used for request cancellation. If +// the context is nil a panic will occur. In the future the SDK may create +// sub-contexts for http.Requests. See https://golang.org/pkg/context/ +// for more information on using Contexts. +func (c *Panorama) CreateJobForDevicesWithContext(ctx aws.Context, input *CreateJobForDevicesInput, opts ...request.Option) (*CreateJobForDevicesOutput, error) { + req, out := c.CreateJobForDevicesRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + +const opCreateNodeFromTemplateJob = "CreateNodeFromTemplateJob" + +// CreateNodeFromTemplateJobRequest generates a "aws/request.Request" representing the +// client's request for the CreateNodeFromTemplateJob operation. The "output" return +// value will be populated with the request's response once the request completes +// successfully. +// +// Use "Send" method on the returned Request to send the API call to the service. +// the "output" return value is not valid until after Send returns without error. +// +// See CreateNodeFromTemplateJob for more information on using the CreateNodeFromTemplateJob +// API call, and error handling. +// +// This method is useful when you want to inject custom logic or configuration +// into the SDK's request lifecycle. Such as custom headers, or retry logic. +// +// +// // Example sending a request using the CreateNodeFromTemplateJobRequest method. +// req, resp := client.CreateNodeFromTemplateJobRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/panorama-2019-07-24/CreateNodeFromTemplateJob +func (c *Panorama) CreateNodeFromTemplateJobRequest(input *CreateNodeFromTemplateJobInput) (req *request.Request, output *CreateNodeFromTemplateJobOutput) { + op := &request.Operation{ + Name: opCreateNodeFromTemplateJob, + HTTPMethod: "POST", + HTTPPath: "/packages/template-job", + } + + if input == nil { + input = &CreateNodeFromTemplateJobInput{} + } + + output = &CreateNodeFromTemplateJobOutput{} + req = c.newRequest(op, input, output) + return +} + +// CreateNodeFromTemplateJob API operation for AWS Panorama. +// +// Creates a camera stream node. +// +// Returns awserr.Error for service API and SDK errors. Use runtime type assertions +// with awserr.Error's Code and Message methods to get detailed information about +// the error. +// +// See the AWS API reference guide for AWS Panorama's +// API operation CreateNodeFromTemplateJob for usage and error information. +// +// Returned Error Types: +// * ValidationException +// The request contains an invalid parameter value. +// +// * InternalServerException +// An internal error occurred. +// +// * AccessDeniedException +// The requestor does not have permission to access the target action or resource. +// +// * ConflictException +// The target resource is in use. +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/panorama-2019-07-24/CreateNodeFromTemplateJob +func (c *Panorama) CreateNodeFromTemplateJob(input *CreateNodeFromTemplateJobInput) (*CreateNodeFromTemplateJobOutput, error) { + req, out := c.CreateNodeFromTemplateJobRequest(input) + return out, req.Send() +} + +// CreateNodeFromTemplateJobWithContext is the same as CreateNodeFromTemplateJob with the addition of +// the ability to pass a context and additional request options. +// +// See CreateNodeFromTemplateJob for details on how to use this API operation. +// +// The context must be non-nil and will be used for request cancellation. If +// the context is nil a panic will occur. In the future the SDK may create +// sub-contexts for http.Requests. See https://golang.org/pkg/context/ +// for more information on using Contexts. +func (c *Panorama) CreateNodeFromTemplateJobWithContext(ctx aws.Context, input *CreateNodeFromTemplateJobInput, opts ...request.Option) (*CreateNodeFromTemplateJobOutput, error) { + req, out := c.CreateNodeFromTemplateJobRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + +const opCreatePackage = "CreatePackage" + +// CreatePackageRequest generates a "aws/request.Request" representing the +// client's request for the CreatePackage operation. The "output" return +// value will be populated with the request's response once the request completes +// successfully. +// +// Use "Send" method on the returned Request to send the API call to the service. +// the "output" return value is not valid until after Send returns without error. +// +// See CreatePackage for more information on using the CreatePackage +// API call, and error handling. +// +// This method is useful when you want to inject custom logic or configuration +// into the SDK's request lifecycle. Such as custom headers, or retry logic. +// +// +// // Example sending a request using the CreatePackageRequest method. +// req, resp := client.CreatePackageRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/panorama-2019-07-24/CreatePackage +func (c *Panorama) CreatePackageRequest(input *CreatePackageInput) (req *request.Request, output *CreatePackageOutput) { + op := &request.Operation{ + Name: opCreatePackage, + HTTPMethod: "POST", + HTTPPath: "/packages", + } + + if input == nil { + input = &CreatePackageInput{} + } + + output = &CreatePackageOutput{} + req = c.newRequest(op, input, output) + return +} + +// CreatePackage API operation for AWS Panorama. +// +// Creates a package and storage location in an Amazon S3 access point. +// +// Returns awserr.Error for service API and SDK errors. Use runtime type assertions +// with awserr.Error's Code and Message methods to get detailed information about +// the error. +// +// See the AWS API reference guide for AWS Panorama's +// API operation CreatePackage for usage and error information. +// +// Returned Error Types: +// * ValidationException +// The request contains an invalid parameter value. +// +// * InternalServerException +// An internal error occurred. +// +// * AccessDeniedException +// The requestor does not have permission to access the target action or resource. +// +// * ConflictException +// The target resource is in use. +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/panorama-2019-07-24/CreatePackage +func (c *Panorama) CreatePackage(input *CreatePackageInput) (*CreatePackageOutput, error) { + req, out := c.CreatePackageRequest(input) + return out, req.Send() +} + +// CreatePackageWithContext is the same as CreatePackage with the addition of +// the ability to pass a context and additional request options. +// +// See CreatePackage for details on how to use this API operation. +// +// The context must be non-nil and will be used for request cancellation. If +// the context is nil a panic will occur. In the future the SDK may create +// sub-contexts for http.Requests. See https://golang.org/pkg/context/ +// for more information on using Contexts. +func (c *Panorama) CreatePackageWithContext(ctx aws.Context, input *CreatePackageInput, opts ...request.Option) (*CreatePackageOutput, error) { + req, out := c.CreatePackageRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + +const opCreatePackageImportJob = "CreatePackageImportJob" + +// CreatePackageImportJobRequest generates a "aws/request.Request" representing the +// client's request for the CreatePackageImportJob operation. The "output" return +// value will be populated with the request's response once the request completes +// successfully. +// +// Use "Send" method on the returned Request to send the API call to the service. +// the "output" return value is not valid until after Send returns without error. +// +// See CreatePackageImportJob for more information on using the CreatePackageImportJob +// API call, and error handling. +// +// This method is useful when you want to inject custom logic or configuration +// into the SDK's request lifecycle. Such as custom headers, or retry logic. +// +// +// // Example sending a request using the CreatePackageImportJobRequest method. +// req, resp := client.CreatePackageImportJobRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/panorama-2019-07-24/CreatePackageImportJob +func (c *Panorama) CreatePackageImportJobRequest(input *CreatePackageImportJobInput) (req *request.Request, output *CreatePackageImportJobOutput) { + op := &request.Operation{ + Name: opCreatePackageImportJob, + HTTPMethod: "POST", + HTTPPath: "/packages/import-jobs", + } + + if input == nil { + input = &CreatePackageImportJobInput{} + } + + output = &CreatePackageImportJobOutput{} + req = c.newRequest(op, input, output) + return +} + +// CreatePackageImportJob API operation for AWS Panorama. +// +// Imports a node package. +// +// Returns awserr.Error for service API and SDK errors. Use runtime type assertions +// with awserr.Error's Code and Message methods to get detailed information about +// the error. +// +// See the AWS API reference guide for AWS Panorama's +// API operation CreatePackageImportJob for usage and error information. +// +// Returned Error Types: +// * ValidationException +// The request contains an invalid parameter value. +// +// * InternalServerException +// An internal error occurred. +// +// * AccessDeniedException +// The requestor does not have permission to access the target action or resource. +// +// * ConflictException +// The target resource is in use. +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/panorama-2019-07-24/CreatePackageImportJob +func (c *Panorama) CreatePackageImportJob(input *CreatePackageImportJobInput) (*CreatePackageImportJobOutput, error) { + req, out := c.CreatePackageImportJobRequest(input) + return out, req.Send() +} + +// CreatePackageImportJobWithContext is the same as CreatePackageImportJob with the addition of +// the ability to pass a context and additional request options. +// +// See CreatePackageImportJob for details on how to use this API operation. +// +// The context must be non-nil and will be used for request cancellation. If +// the context is nil a panic will occur. In the future the SDK may create +// sub-contexts for http.Requests. See https://golang.org/pkg/context/ +// for more information on using Contexts. +func (c *Panorama) CreatePackageImportJobWithContext(ctx aws.Context, input *CreatePackageImportJobInput, opts ...request.Option) (*CreatePackageImportJobOutput, error) { + req, out := c.CreatePackageImportJobRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + +const opDeleteDevice = "DeleteDevice" + +// DeleteDeviceRequest generates a "aws/request.Request" representing the +// client's request for the DeleteDevice operation. The "output" return +// value will be populated with the request's response once the request completes +// successfully. +// +// Use "Send" method on the returned Request to send the API call to the service. +// the "output" return value is not valid until after Send returns without error. +// +// See DeleteDevice for more information on using the DeleteDevice +// API call, and error handling. +// +// This method is useful when you want to inject custom logic or configuration +// into the SDK's request lifecycle. Such as custom headers, or retry logic. +// +// +// // Example sending a request using the DeleteDeviceRequest method. +// req, resp := client.DeleteDeviceRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/panorama-2019-07-24/DeleteDevice +func (c *Panorama) DeleteDeviceRequest(input *DeleteDeviceInput) (req *request.Request, output *DeleteDeviceOutput) { + op := &request.Operation{ + Name: opDeleteDevice, + HTTPMethod: "DELETE", + HTTPPath: "/devices/{DeviceId}", + } + + if input == nil { + input = &DeleteDeviceInput{} + } + + output = &DeleteDeviceOutput{} + req = c.newRequest(op, input, output) + return +} + +// DeleteDevice API operation for AWS Panorama. +// +// Deletes a device. +// +// Returns awserr.Error for service API and SDK errors. Use runtime type assertions +// with awserr.Error's Code and Message methods to get detailed information about +// the error. +// +// See the AWS API reference guide for AWS Panorama's +// API operation DeleteDevice for usage and error information. +// +// Returned Error Types: +// * ConflictException +// The target resource is in use. +// +// * ValidationException +// The request contains an invalid parameter value. +// +// * InternalServerException +// An internal error occurred. +// +// * AccessDeniedException +// The requestor does not have permission to access the target action or resource. +// +// * ResourceNotFoundException +// The target resource was not found. +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/panorama-2019-07-24/DeleteDevice +func (c *Panorama) DeleteDevice(input *DeleteDeviceInput) (*DeleteDeviceOutput, error) { + req, out := c.DeleteDeviceRequest(input) + return out, req.Send() +} + +// DeleteDeviceWithContext is the same as DeleteDevice with the addition of +// the ability to pass a context and additional request options. +// +// See DeleteDevice for details on how to use this API operation. +// +// The context must be non-nil and will be used for request cancellation. If +// the context is nil a panic will occur. In the future the SDK may create +// sub-contexts for http.Requests. See https://golang.org/pkg/context/ +// for more information on using Contexts. +func (c *Panorama) DeleteDeviceWithContext(ctx aws.Context, input *DeleteDeviceInput, opts ...request.Option) (*DeleteDeviceOutput, error) { + req, out := c.DeleteDeviceRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + +const opDeletePackage = "DeletePackage" + +// DeletePackageRequest generates a "aws/request.Request" representing the +// client's request for the DeletePackage operation. The "output" return +// value will be populated with the request's response once the request completes +// successfully. +// +// Use "Send" method on the returned Request to send the API call to the service. +// the "output" return value is not valid until after Send returns without error. +// +// See DeletePackage for more information on using the DeletePackage +// API call, and error handling. +// +// This method is useful when you want to inject custom logic or configuration +// into the SDK's request lifecycle. Such as custom headers, or retry logic. +// +// +// // Example sending a request using the DeletePackageRequest method. +// req, resp := client.DeletePackageRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/panorama-2019-07-24/DeletePackage +func (c *Panorama) DeletePackageRequest(input *DeletePackageInput) (req *request.Request, output *DeletePackageOutput) { + op := &request.Operation{ + Name: opDeletePackage, + HTTPMethod: "DELETE", + HTTPPath: "/packages/{PackageId}", + } + + if input == nil { + input = &DeletePackageInput{} + } + + output = &DeletePackageOutput{} + req = c.newRequest(op, input, output) + req.Handlers.Unmarshal.Swap(restjson.UnmarshalHandler.Name, protocol.UnmarshalDiscardBodyHandler) + return +} + +// DeletePackage API operation for AWS Panorama. +// +// Deletes a package. +// +// Returns awserr.Error for service API and SDK errors. Use runtime type assertions +// with awserr.Error's Code and Message methods to get detailed information about +// the error. +// +// See the AWS API reference guide for AWS Panorama's +// API operation DeletePackage for usage and error information. +// +// Returned Error Types: +// * ValidationException +// The request contains an invalid parameter value. +// +// * InternalServerException +// An internal error occurred. +// +// * AccessDeniedException +// The requestor does not have permission to access the target action or resource. +// +// * ConflictException +// The target resource is in use. +// +// * ResourceNotFoundException +// The target resource was not found. +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/panorama-2019-07-24/DeletePackage +func (c *Panorama) DeletePackage(input *DeletePackageInput) (*DeletePackageOutput, error) { + req, out := c.DeletePackageRequest(input) + return out, req.Send() +} + +// DeletePackageWithContext is the same as DeletePackage with the addition of +// the ability to pass a context and additional request options. +// +// See DeletePackage for details on how to use this API operation. +// +// The context must be non-nil and will be used for request cancellation. If +// the context is nil a panic will occur. In the future the SDK may create +// sub-contexts for http.Requests. See https://golang.org/pkg/context/ +// for more information on using Contexts. +func (c *Panorama) DeletePackageWithContext(ctx aws.Context, input *DeletePackageInput, opts ...request.Option) (*DeletePackageOutput, error) { + req, out := c.DeletePackageRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + +const opDeregisterPackageVersion = "DeregisterPackageVersion" + +// DeregisterPackageVersionRequest generates a "aws/request.Request" representing the +// client's request for the DeregisterPackageVersion operation. The "output" return +// value will be populated with the request's response once the request completes +// successfully. +// +// Use "Send" method on the returned Request to send the API call to the service. +// the "output" return value is not valid until after Send returns without error. +// +// See DeregisterPackageVersion for more information on using the DeregisterPackageVersion +// API call, and error handling. +// +// This method is useful when you want to inject custom logic or configuration +// into the SDK's request lifecycle. Such as custom headers, or retry logic. +// +// +// // Example sending a request using the DeregisterPackageVersionRequest method. +// req, resp := client.DeregisterPackageVersionRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/panorama-2019-07-24/DeregisterPackageVersion +func (c *Panorama) DeregisterPackageVersionRequest(input *DeregisterPackageVersionInput) (req *request.Request, output *DeregisterPackageVersionOutput) { + op := &request.Operation{ + Name: opDeregisterPackageVersion, + HTTPMethod: "DELETE", + HTTPPath: "/packages/{PackageId}/versions/{PackageVersion}/patch/{PatchVersion}", + } + + if input == nil { + input = &DeregisterPackageVersionInput{} + } + + output = &DeregisterPackageVersionOutput{} + req = c.newRequest(op, input, output) + req.Handlers.Unmarshal.Swap(restjson.UnmarshalHandler.Name, protocol.UnmarshalDiscardBodyHandler) + return +} + +// DeregisterPackageVersion API operation for AWS Panorama. +// +// Deregisters a package version. +// +// Returns awserr.Error for service API and SDK errors. Use runtime type assertions +// with awserr.Error's Code and Message methods to get detailed information about +// the error. +// +// See the AWS API reference guide for AWS Panorama's +// API operation DeregisterPackageVersion for usage and error information. +// +// Returned Error Types: +// * ValidationException +// The request contains an invalid parameter value. +// +// * InternalServerException +// An internal error occurred. +// +// * AccessDeniedException +// The requestor does not have permission to access the target action or resource. +// +// * ConflictException +// The target resource is in use. +// +// * ResourceNotFoundException +// The target resource was not found. +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/panorama-2019-07-24/DeregisterPackageVersion +func (c *Panorama) DeregisterPackageVersion(input *DeregisterPackageVersionInput) (*DeregisterPackageVersionOutput, error) { + req, out := c.DeregisterPackageVersionRequest(input) + return out, req.Send() +} + +// DeregisterPackageVersionWithContext is the same as DeregisterPackageVersion with the addition of +// the ability to pass a context and additional request options. +// +// See DeregisterPackageVersion for details on how to use this API operation. +// +// The context must be non-nil and will be used for request cancellation. If +// the context is nil a panic will occur. In the future the SDK may create +// sub-contexts for http.Requests. See https://golang.org/pkg/context/ +// for more information on using Contexts. +func (c *Panorama) DeregisterPackageVersionWithContext(ctx aws.Context, input *DeregisterPackageVersionInput, opts ...request.Option) (*DeregisterPackageVersionOutput, error) { + req, out := c.DeregisterPackageVersionRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + +const opDescribeApplicationInstance = "DescribeApplicationInstance" + +// DescribeApplicationInstanceRequest generates a "aws/request.Request" representing the +// client's request for the DescribeApplicationInstance operation. The "output" return +// value will be populated with the request's response once the request completes +// successfully. +// +// Use "Send" method on the returned Request to send the API call to the service. +// the "output" return value is not valid until after Send returns without error. +// +// See DescribeApplicationInstance for more information on using the DescribeApplicationInstance +// API call, and error handling. +// +// This method is useful when you want to inject custom logic or configuration +// into the SDK's request lifecycle. Such as custom headers, or retry logic. +// +// +// // Example sending a request using the DescribeApplicationInstanceRequest method. +// req, resp := client.DescribeApplicationInstanceRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/panorama-2019-07-24/DescribeApplicationInstance +func (c *Panorama) DescribeApplicationInstanceRequest(input *DescribeApplicationInstanceInput) (req *request.Request, output *DescribeApplicationInstanceOutput) { + op := &request.Operation{ + Name: opDescribeApplicationInstance, + HTTPMethod: "GET", + HTTPPath: "/application-instances/{applicationInstanceId}", + } + + if input == nil { + input = &DescribeApplicationInstanceInput{} + } + + output = &DescribeApplicationInstanceOutput{} + req = c.newRequest(op, input, output) + return +} + +// DescribeApplicationInstance API operation for AWS Panorama. +// +// Returns information about an application instance on a device. +// +// Returns awserr.Error for service API and SDK errors. Use runtime type assertions +// with awserr.Error's Code and Message methods to get detailed information about +// the error. +// +// See the AWS API reference guide for AWS Panorama's +// API operation DescribeApplicationInstance for usage and error information. +// +// Returned Error Types: +// * ConflictException +// The target resource is in use. +// +// * ValidationException +// The request contains an invalid parameter value. +// +// * InternalServerException +// An internal error occurred. +// +// * AccessDeniedException +// The requestor does not have permission to access the target action or resource. +// +// * ResourceNotFoundException +// The target resource was not found. +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/panorama-2019-07-24/DescribeApplicationInstance +func (c *Panorama) DescribeApplicationInstance(input *DescribeApplicationInstanceInput) (*DescribeApplicationInstanceOutput, error) { + req, out := c.DescribeApplicationInstanceRequest(input) + return out, req.Send() +} + +// DescribeApplicationInstanceWithContext is the same as DescribeApplicationInstance with the addition of +// the ability to pass a context and additional request options. +// +// See DescribeApplicationInstance for details on how to use this API operation. +// +// The context must be non-nil and will be used for request cancellation. If +// the context is nil a panic will occur. In the future the SDK may create +// sub-contexts for http.Requests. See https://golang.org/pkg/context/ +// for more information on using Contexts. +func (c *Panorama) DescribeApplicationInstanceWithContext(ctx aws.Context, input *DescribeApplicationInstanceInput, opts ...request.Option) (*DescribeApplicationInstanceOutput, error) { + req, out := c.DescribeApplicationInstanceRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + +const opDescribeApplicationInstanceDetails = "DescribeApplicationInstanceDetails" + +// DescribeApplicationInstanceDetailsRequest generates a "aws/request.Request" representing the +// client's request for the DescribeApplicationInstanceDetails operation. The "output" return +// value will be populated with the request's response once the request completes +// successfully. +// +// Use "Send" method on the returned Request to send the API call to the service. +// the "output" return value is not valid until after Send returns without error. +// +// See DescribeApplicationInstanceDetails for more information on using the DescribeApplicationInstanceDetails +// API call, and error handling. +// +// This method is useful when you want to inject custom logic or configuration +// into the SDK's request lifecycle. Such as custom headers, or retry logic. +// +// +// // Example sending a request using the DescribeApplicationInstanceDetailsRequest method. +// req, resp := client.DescribeApplicationInstanceDetailsRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/panorama-2019-07-24/DescribeApplicationInstanceDetails +func (c *Panorama) DescribeApplicationInstanceDetailsRequest(input *DescribeApplicationInstanceDetailsInput) (req *request.Request, output *DescribeApplicationInstanceDetailsOutput) { + op := &request.Operation{ + Name: opDescribeApplicationInstanceDetails, + HTTPMethod: "GET", + HTTPPath: "/application-instances/{applicationInstanceId}/details", + } + + if input == nil { + input = &DescribeApplicationInstanceDetailsInput{} + } + + output = &DescribeApplicationInstanceDetailsOutput{} + req = c.newRequest(op, input, output) + return +} + +// DescribeApplicationInstanceDetails API operation for AWS Panorama. +// +// Returns information about an application instance's configuration manifest. +// +// Returns awserr.Error for service API and SDK errors. Use runtime type assertions +// with awserr.Error's Code and Message methods to get detailed information about +// the error. +// +// See the AWS API reference guide for AWS Panorama's +// API operation DescribeApplicationInstanceDetails for usage and error information. +// +// Returned Error Types: +// * ConflictException +// The target resource is in use. +// +// * ValidationException +// The request contains an invalid parameter value. +// +// * InternalServerException +// An internal error occurred. +// +// * AccessDeniedException +// The requestor does not have permission to access the target action or resource. +// +// * ResourceNotFoundException +// The target resource was not found. +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/panorama-2019-07-24/DescribeApplicationInstanceDetails +func (c *Panorama) DescribeApplicationInstanceDetails(input *DescribeApplicationInstanceDetailsInput) (*DescribeApplicationInstanceDetailsOutput, error) { + req, out := c.DescribeApplicationInstanceDetailsRequest(input) + return out, req.Send() +} + +// DescribeApplicationInstanceDetailsWithContext is the same as DescribeApplicationInstanceDetails with the addition of +// the ability to pass a context and additional request options. +// +// See DescribeApplicationInstanceDetails for details on how to use this API operation. +// +// The context must be non-nil and will be used for request cancellation. If +// the context is nil a panic will occur. In the future the SDK may create +// sub-contexts for http.Requests. See https://golang.org/pkg/context/ +// for more information on using Contexts. +func (c *Panorama) DescribeApplicationInstanceDetailsWithContext(ctx aws.Context, input *DescribeApplicationInstanceDetailsInput, opts ...request.Option) (*DescribeApplicationInstanceDetailsOutput, error) { + req, out := c.DescribeApplicationInstanceDetailsRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + +const opDescribeDevice = "DescribeDevice" + +// DescribeDeviceRequest generates a "aws/request.Request" representing the +// client's request for the DescribeDevice operation. The "output" return +// value will be populated with the request's response once the request completes +// successfully. +// +// Use "Send" method on the returned Request to send the API call to the service. +// the "output" return value is not valid until after Send returns without error. +// +// See DescribeDevice for more information on using the DescribeDevice +// API call, and error handling. +// +// This method is useful when you want to inject custom logic or configuration +// into the SDK's request lifecycle. Such as custom headers, or retry logic. +// +// +// // Example sending a request using the DescribeDeviceRequest method. +// req, resp := client.DescribeDeviceRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/panorama-2019-07-24/DescribeDevice +func (c *Panorama) DescribeDeviceRequest(input *DescribeDeviceInput) (req *request.Request, output *DescribeDeviceOutput) { + op := &request.Operation{ + Name: opDescribeDevice, + HTTPMethod: "GET", + HTTPPath: "/devices/{DeviceId}", + } + + if input == nil { + input = &DescribeDeviceInput{} + } + + output = &DescribeDeviceOutput{} + req = c.newRequest(op, input, output) + return +} + +// DescribeDevice API operation for AWS Panorama. +// +// Returns information about a device. +// +// Returns awserr.Error for service API and SDK errors. Use runtime type assertions +// with awserr.Error's Code and Message methods to get detailed information about +// the error. +// +// See the AWS API reference guide for AWS Panorama's +// API operation DescribeDevice for usage and error information. +// +// Returned Error Types: +// * ValidationException +// The request contains an invalid parameter value. +// +// * InternalServerException +// An internal error occurred. +// +// * AccessDeniedException +// The requestor does not have permission to access the target action or resource. +// +// * ResourceNotFoundException +// The target resource was not found. +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/panorama-2019-07-24/DescribeDevice +func (c *Panorama) DescribeDevice(input *DescribeDeviceInput) (*DescribeDeviceOutput, error) { + req, out := c.DescribeDeviceRequest(input) + return out, req.Send() +} + +// DescribeDeviceWithContext is the same as DescribeDevice with the addition of +// the ability to pass a context and additional request options. +// +// See DescribeDevice for details on how to use this API operation. +// +// The context must be non-nil and will be used for request cancellation. If +// the context is nil a panic will occur. In the future the SDK may create +// sub-contexts for http.Requests. See https://golang.org/pkg/context/ +// for more information on using Contexts. +func (c *Panorama) DescribeDeviceWithContext(ctx aws.Context, input *DescribeDeviceInput, opts ...request.Option) (*DescribeDeviceOutput, error) { + req, out := c.DescribeDeviceRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + +const opDescribeDeviceJob = "DescribeDeviceJob" + +// DescribeDeviceJobRequest generates a "aws/request.Request" representing the +// client's request for the DescribeDeviceJob operation. The "output" return +// value will be populated with the request's response once the request completes +// successfully. +// +// Use "Send" method on the returned Request to send the API call to the service. +// the "output" return value is not valid until after Send returns without error. +// +// See DescribeDeviceJob for more information on using the DescribeDeviceJob +// API call, and error handling. +// +// This method is useful when you want to inject custom logic or configuration +// into the SDK's request lifecycle. Such as custom headers, or retry logic. +// +// +// // Example sending a request using the DescribeDeviceJobRequest method. +// req, resp := client.DescribeDeviceJobRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/panorama-2019-07-24/DescribeDeviceJob +func (c *Panorama) DescribeDeviceJobRequest(input *DescribeDeviceJobInput) (req *request.Request, output *DescribeDeviceJobOutput) { + op := &request.Operation{ + Name: opDescribeDeviceJob, + HTTPMethod: "GET", + HTTPPath: "/jobs/{JobId}", + } + + if input == nil { + input = &DescribeDeviceJobInput{} + } + + output = &DescribeDeviceJobOutput{} + req = c.newRequest(op, input, output) + return +} + +// DescribeDeviceJob API operation for AWS Panorama. +// +// Returns information about a device job. +// +// Returns awserr.Error for service API and SDK errors. Use runtime type assertions +// with awserr.Error's Code and Message methods to get detailed information about +// the error. +// +// See the AWS API reference guide for AWS Panorama's +// API operation DescribeDeviceJob for usage and error information. +// +// Returned Error Types: +// * ConflictException +// The target resource is in use. +// +// * ValidationException +// The request contains an invalid parameter value. +// +// * InternalServerException +// An internal error occurred. +// +// * AccessDeniedException +// The requestor does not have permission to access the target action or resource. +// +// * ResourceNotFoundException +// The target resource was not found. +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/panorama-2019-07-24/DescribeDeviceJob +func (c *Panorama) DescribeDeviceJob(input *DescribeDeviceJobInput) (*DescribeDeviceJobOutput, error) { + req, out := c.DescribeDeviceJobRequest(input) + return out, req.Send() +} + +// DescribeDeviceJobWithContext is the same as DescribeDeviceJob with the addition of +// the ability to pass a context and additional request options. +// +// See DescribeDeviceJob for details on how to use this API operation. +// +// The context must be non-nil and will be used for request cancellation. If +// the context is nil a panic will occur. In the future the SDK may create +// sub-contexts for http.Requests. See https://golang.org/pkg/context/ +// for more information on using Contexts. +func (c *Panorama) DescribeDeviceJobWithContext(ctx aws.Context, input *DescribeDeviceJobInput, opts ...request.Option) (*DescribeDeviceJobOutput, error) { + req, out := c.DescribeDeviceJobRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + +const opDescribeNode = "DescribeNode" + +// DescribeNodeRequest generates a "aws/request.Request" representing the +// client's request for the DescribeNode operation. The "output" return +// value will be populated with the request's response once the request completes +// successfully. +// +// Use "Send" method on the returned Request to send the API call to the service. +// the "output" return value is not valid until after Send returns without error. +// +// See DescribeNode for more information on using the DescribeNode +// API call, and error handling. +// +// This method is useful when you want to inject custom logic or configuration +// into the SDK's request lifecycle. Such as custom headers, or retry logic. +// +// +// // Example sending a request using the DescribeNodeRequest method. +// req, resp := client.DescribeNodeRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/panorama-2019-07-24/DescribeNode +func (c *Panorama) DescribeNodeRequest(input *DescribeNodeInput) (req *request.Request, output *DescribeNodeOutput) { + op := &request.Operation{ + Name: opDescribeNode, + HTTPMethod: "GET", + HTTPPath: "/nodes/{NodeId}", + } + + if input == nil { + input = &DescribeNodeInput{} + } + + output = &DescribeNodeOutput{} + req = c.newRequest(op, input, output) + return +} + +// DescribeNode API operation for AWS Panorama. +// +// Returns information about a node. +// +// Returns awserr.Error for service API and SDK errors. Use runtime type assertions +// with awserr.Error's Code and Message methods to get detailed information about +// the error. +// +// See the AWS API reference guide for AWS Panorama's +// API operation DescribeNode for usage and error information. +// +// Returned Error Types: +// * ConflictException +// The target resource is in use. +// +// * ValidationException +// The request contains an invalid parameter value. +// +// * InternalServerException +// An internal error occurred. +// +// * AccessDeniedException +// The requestor does not have permission to access the target action or resource. +// +// * ResourceNotFoundException +// The target resource was not found. +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/panorama-2019-07-24/DescribeNode +func (c *Panorama) DescribeNode(input *DescribeNodeInput) (*DescribeNodeOutput, error) { + req, out := c.DescribeNodeRequest(input) + return out, req.Send() +} + +// DescribeNodeWithContext is the same as DescribeNode with the addition of +// the ability to pass a context and additional request options. +// +// See DescribeNode for details on how to use this API operation. +// +// The context must be non-nil and will be used for request cancellation. If +// the context is nil a panic will occur. In the future the SDK may create +// sub-contexts for http.Requests. See https://golang.org/pkg/context/ +// for more information on using Contexts. +func (c *Panorama) DescribeNodeWithContext(ctx aws.Context, input *DescribeNodeInput, opts ...request.Option) (*DescribeNodeOutput, error) { + req, out := c.DescribeNodeRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + +const opDescribeNodeFromTemplateJob = "DescribeNodeFromTemplateJob" + +// DescribeNodeFromTemplateJobRequest generates a "aws/request.Request" representing the +// client's request for the DescribeNodeFromTemplateJob operation. The "output" return +// value will be populated with the request's response once the request completes +// successfully. +// +// Use "Send" method on the returned Request to send the API call to the service. +// the "output" return value is not valid until after Send returns without error. +// +// See DescribeNodeFromTemplateJob for more information on using the DescribeNodeFromTemplateJob +// API call, and error handling. +// +// This method is useful when you want to inject custom logic or configuration +// into the SDK's request lifecycle. Such as custom headers, or retry logic. +// +// +// // Example sending a request using the DescribeNodeFromTemplateJobRequest method. +// req, resp := client.DescribeNodeFromTemplateJobRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/panorama-2019-07-24/DescribeNodeFromTemplateJob +func (c *Panorama) DescribeNodeFromTemplateJobRequest(input *DescribeNodeFromTemplateJobInput) (req *request.Request, output *DescribeNodeFromTemplateJobOutput) { + op := &request.Operation{ + Name: opDescribeNodeFromTemplateJob, + HTTPMethod: "GET", + HTTPPath: "/packages/template-job/{JobId}", + } + + if input == nil { + input = &DescribeNodeFromTemplateJobInput{} + } + + output = &DescribeNodeFromTemplateJobOutput{} + req = c.newRequest(op, input, output) + return +} + +// DescribeNodeFromTemplateJob API operation for AWS Panorama. +// +// Returns information about a job to create a camera stream node. +// +// Returns awserr.Error for service API and SDK errors. Use runtime type assertions +// with awserr.Error's Code and Message methods to get detailed information about +// the error. +// +// See the AWS API reference guide for AWS Panorama's +// API operation DescribeNodeFromTemplateJob for usage and error information. +// +// Returned Error Types: +// * ValidationException +// The request contains an invalid parameter value. +// +// * InternalServerException +// An internal error occurred. +// +// * AccessDeniedException +// The requestor does not have permission to access the target action or resource. +// +// * ConflictException +// The target resource is in use. +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/panorama-2019-07-24/DescribeNodeFromTemplateJob +func (c *Panorama) DescribeNodeFromTemplateJob(input *DescribeNodeFromTemplateJobInput) (*DescribeNodeFromTemplateJobOutput, error) { + req, out := c.DescribeNodeFromTemplateJobRequest(input) + return out, req.Send() +} + +// DescribeNodeFromTemplateJobWithContext is the same as DescribeNodeFromTemplateJob with the addition of +// the ability to pass a context and additional request options. +// +// See DescribeNodeFromTemplateJob for details on how to use this API operation. +// +// The context must be non-nil and will be used for request cancellation. If +// the context is nil a panic will occur. In the future the SDK may create +// sub-contexts for http.Requests. See https://golang.org/pkg/context/ +// for more information on using Contexts. +func (c *Panorama) DescribeNodeFromTemplateJobWithContext(ctx aws.Context, input *DescribeNodeFromTemplateJobInput, opts ...request.Option) (*DescribeNodeFromTemplateJobOutput, error) { + req, out := c.DescribeNodeFromTemplateJobRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + +const opDescribePackage = "DescribePackage" + +// DescribePackageRequest generates a "aws/request.Request" representing the +// client's request for the DescribePackage operation. The "output" return +// value will be populated with the request's response once the request completes +// successfully. +// +// Use "Send" method on the returned Request to send the API call to the service. +// the "output" return value is not valid until after Send returns without error. +// +// See DescribePackage for more information on using the DescribePackage +// API call, and error handling. +// +// This method is useful when you want to inject custom logic or configuration +// into the SDK's request lifecycle. Such as custom headers, or retry logic. +// +// +// // Example sending a request using the DescribePackageRequest method. +// req, resp := client.DescribePackageRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/panorama-2019-07-24/DescribePackage +func (c *Panorama) DescribePackageRequest(input *DescribePackageInput) (req *request.Request, output *DescribePackageOutput) { + op := &request.Operation{ + Name: opDescribePackage, + HTTPMethod: "GET", + HTTPPath: "/packages/metadata/{PackageId}", + } + + if input == nil { + input = &DescribePackageInput{} + } + + output = &DescribePackageOutput{} + req = c.newRequest(op, input, output) + return +} + +// DescribePackage API operation for AWS Panorama. +// +// Returns information about a package. +// +// Returns awserr.Error for service API and SDK errors. Use runtime type assertions +// with awserr.Error's Code and Message methods to get detailed information about +// the error. +// +// See the AWS API reference guide for AWS Panorama's +// API operation DescribePackage for usage and error information. +// +// Returned Error Types: +// * ValidationException +// The request contains an invalid parameter value. +// +// * InternalServerException +// An internal error occurred. +// +// * AccessDeniedException +// The requestor does not have permission to access the target action or resource. +// +// * ConflictException +// The target resource is in use. +// +// * ResourceNotFoundException +// The target resource was not found. +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/panorama-2019-07-24/DescribePackage +func (c *Panorama) DescribePackage(input *DescribePackageInput) (*DescribePackageOutput, error) { + req, out := c.DescribePackageRequest(input) + return out, req.Send() +} + +// DescribePackageWithContext is the same as DescribePackage with the addition of +// the ability to pass a context and additional request options. +// +// See DescribePackage for details on how to use this API operation. +// +// The context must be non-nil and will be used for request cancellation. If +// the context is nil a panic will occur. In the future the SDK may create +// sub-contexts for http.Requests. See https://golang.org/pkg/context/ +// for more information on using Contexts. +func (c *Panorama) DescribePackageWithContext(ctx aws.Context, input *DescribePackageInput, opts ...request.Option) (*DescribePackageOutput, error) { + req, out := c.DescribePackageRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + +const opDescribePackageImportJob = "DescribePackageImportJob" + +// DescribePackageImportJobRequest generates a "aws/request.Request" representing the +// client's request for the DescribePackageImportJob operation. The "output" return +// value will be populated with the request's response once the request completes +// successfully. +// +// Use "Send" method on the returned Request to send the API call to the service. +// the "output" return value is not valid until after Send returns without error. +// +// See DescribePackageImportJob for more information on using the DescribePackageImportJob +// API call, and error handling. +// +// This method is useful when you want to inject custom logic or configuration +// into the SDK's request lifecycle. Such as custom headers, or retry logic. +// +// +// // Example sending a request using the DescribePackageImportJobRequest method. +// req, resp := client.DescribePackageImportJobRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/panorama-2019-07-24/DescribePackageImportJob +func (c *Panorama) DescribePackageImportJobRequest(input *DescribePackageImportJobInput) (req *request.Request, output *DescribePackageImportJobOutput) { + op := &request.Operation{ + Name: opDescribePackageImportJob, + HTTPMethod: "GET", + HTTPPath: "/packages/import-jobs/{JobId}", + } + + if input == nil { + input = &DescribePackageImportJobInput{} + } + + output = &DescribePackageImportJobOutput{} + req = c.newRequest(op, input, output) + return +} + +// DescribePackageImportJob API operation for AWS Panorama. +// +// Returns information about a package import job. +// +// Returns awserr.Error for service API and SDK errors. Use runtime type assertions +// with awserr.Error's Code and Message methods to get detailed information about +// the error. +// +// See the AWS API reference guide for AWS Panorama's +// API operation DescribePackageImportJob for usage and error information. +// +// Returned Error Types: +// * ValidationException +// The request contains an invalid parameter value. +// +// * InternalServerException +// An internal error occurred. +// +// * AccessDeniedException +// The requestor does not have permission to access the target action or resource. +// +// * ConflictException +// The target resource is in use. +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/panorama-2019-07-24/DescribePackageImportJob +func (c *Panorama) DescribePackageImportJob(input *DescribePackageImportJobInput) (*DescribePackageImportJobOutput, error) { + req, out := c.DescribePackageImportJobRequest(input) + return out, req.Send() +} + +// DescribePackageImportJobWithContext is the same as DescribePackageImportJob with the addition of +// the ability to pass a context and additional request options. +// +// See DescribePackageImportJob for details on how to use this API operation. +// +// The context must be non-nil and will be used for request cancellation. If +// the context is nil a panic will occur. In the future the SDK may create +// sub-contexts for http.Requests. See https://golang.org/pkg/context/ +// for more information on using Contexts. +func (c *Panorama) DescribePackageImportJobWithContext(ctx aws.Context, input *DescribePackageImportJobInput, opts ...request.Option) (*DescribePackageImportJobOutput, error) { + req, out := c.DescribePackageImportJobRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + +const opDescribePackageVersion = "DescribePackageVersion" + +// DescribePackageVersionRequest generates a "aws/request.Request" representing the +// client's request for the DescribePackageVersion operation. The "output" return +// value will be populated with the request's response once the request completes +// successfully. +// +// Use "Send" method on the returned Request to send the API call to the service. +// the "output" return value is not valid until after Send returns without error. +// +// See DescribePackageVersion for more information on using the DescribePackageVersion +// API call, and error handling. +// +// This method is useful when you want to inject custom logic or configuration +// into the SDK's request lifecycle. Such as custom headers, or retry logic. +// +// +// // Example sending a request using the DescribePackageVersionRequest method. +// req, resp := client.DescribePackageVersionRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/panorama-2019-07-24/DescribePackageVersion +func (c *Panorama) DescribePackageVersionRequest(input *DescribePackageVersionInput) (req *request.Request, output *DescribePackageVersionOutput) { + op := &request.Operation{ + Name: opDescribePackageVersion, + HTTPMethod: "GET", + HTTPPath: "/packages/metadata/{PackageId}/versions/{PackageVersion}", + } + + if input == nil { + input = &DescribePackageVersionInput{} + } + + output = &DescribePackageVersionOutput{} + req = c.newRequest(op, input, output) + return +} + +// DescribePackageVersion API operation for AWS Panorama. +// +// Returns information about a package version. +// +// Returns awserr.Error for service API and SDK errors. Use runtime type assertions +// with awserr.Error's Code and Message methods to get detailed information about +// the error. +// +// See the AWS API reference guide for AWS Panorama's +// API operation DescribePackageVersion for usage and error information. +// +// Returned Error Types: +// * ValidationException +// The request contains an invalid parameter value. +// +// * InternalServerException +// An internal error occurred. +// +// * AccessDeniedException +// The requestor does not have permission to access the target action or resource. +// +// * ConflictException +// The target resource is in use. +// +// * ResourceNotFoundException +// The target resource was not found. +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/panorama-2019-07-24/DescribePackageVersion +func (c *Panorama) DescribePackageVersion(input *DescribePackageVersionInput) (*DescribePackageVersionOutput, error) { + req, out := c.DescribePackageVersionRequest(input) + return out, req.Send() +} + +// DescribePackageVersionWithContext is the same as DescribePackageVersion with the addition of +// the ability to pass a context and additional request options. +// +// See DescribePackageVersion for details on how to use this API operation. +// +// The context must be non-nil and will be used for request cancellation. If +// the context is nil a panic will occur. In the future the SDK may create +// sub-contexts for http.Requests. See https://golang.org/pkg/context/ +// for more information on using Contexts. +func (c *Panorama) DescribePackageVersionWithContext(ctx aws.Context, input *DescribePackageVersionInput, opts ...request.Option) (*DescribePackageVersionOutput, error) { + req, out := c.DescribePackageVersionRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + +const opListApplicationInstanceDependencies = "ListApplicationInstanceDependencies" + +// ListApplicationInstanceDependenciesRequest generates a "aws/request.Request" representing the +// client's request for the ListApplicationInstanceDependencies operation. The "output" return +// value will be populated with the request's response once the request completes +// successfully. +// +// Use "Send" method on the returned Request to send the API call to the service. +// the "output" return value is not valid until after Send returns without error. +// +// See ListApplicationInstanceDependencies for more information on using the ListApplicationInstanceDependencies +// API call, and error handling. +// +// This method is useful when you want to inject custom logic or configuration +// into the SDK's request lifecycle. Such as custom headers, or retry logic. +// +// +// // Example sending a request using the ListApplicationInstanceDependenciesRequest method. +// req, resp := client.ListApplicationInstanceDependenciesRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/panorama-2019-07-24/ListApplicationInstanceDependencies +func (c *Panorama) ListApplicationInstanceDependenciesRequest(input *ListApplicationInstanceDependenciesInput) (req *request.Request, output *ListApplicationInstanceDependenciesOutput) { + op := &request.Operation{ + Name: opListApplicationInstanceDependencies, + HTTPMethod: "GET", + HTTPPath: "/application-instances/{applicationInstanceId}/package-dependencies", + Paginator: &request.Paginator{ + InputTokens: []string{"NextToken"}, + OutputTokens: []string{"NextToken"}, + LimitToken: "MaxResults", + TruncationToken: "", + }, + } + + if input == nil { + input = &ListApplicationInstanceDependenciesInput{} + } + + output = &ListApplicationInstanceDependenciesOutput{} + req = c.newRequest(op, input, output) + return +} + +// ListApplicationInstanceDependencies API operation for AWS Panorama. +// +// Returns a list of application instance dependencies. +// +// Returns awserr.Error for service API and SDK errors. Use runtime type assertions +// with awserr.Error's Code and Message methods to get detailed information about +// the error. +// +// See the AWS API reference guide for AWS Panorama's +// API operation ListApplicationInstanceDependencies for usage and error information. +// +// Returned Error Types: +// * AccessDeniedException +// The requestor does not have permission to access the target action or resource. +// +// * InternalServerException +// An internal error occurred. +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/panorama-2019-07-24/ListApplicationInstanceDependencies +func (c *Panorama) ListApplicationInstanceDependencies(input *ListApplicationInstanceDependenciesInput) (*ListApplicationInstanceDependenciesOutput, error) { + req, out := c.ListApplicationInstanceDependenciesRequest(input) + return out, req.Send() +} + +// ListApplicationInstanceDependenciesWithContext is the same as ListApplicationInstanceDependencies with the addition of +// the ability to pass a context and additional request options. +// +// See ListApplicationInstanceDependencies for details on how to use this API operation. +// +// The context must be non-nil and will be used for request cancellation. If +// the context is nil a panic will occur. In the future the SDK may create +// sub-contexts for http.Requests. See https://golang.org/pkg/context/ +// for more information on using Contexts. +func (c *Panorama) ListApplicationInstanceDependenciesWithContext(ctx aws.Context, input *ListApplicationInstanceDependenciesInput, opts ...request.Option) (*ListApplicationInstanceDependenciesOutput, error) { + req, out := c.ListApplicationInstanceDependenciesRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + +// ListApplicationInstanceDependenciesPages iterates over the pages of a ListApplicationInstanceDependencies operation, +// calling the "fn" function with the response data for each page. To stop +// iterating, return false from the fn function. +// +// See ListApplicationInstanceDependencies method for more information on how to use this operation. +// +// Note: This operation can generate multiple requests to a service. +// +// // Example iterating over at most 3 pages of a ListApplicationInstanceDependencies operation. +// pageNum := 0 +// err := client.ListApplicationInstanceDependenciesPages(params, +// func(page *panorama.ListApplicationInstanceDependenciesOutput, lastPage bool) bool { +// pageNum++ +// fmt.Println(page) +// return pageNum <= 3 +// }) +// +func (c *Panorama) ListApplicationInstanceDependenciesPages(input *ListApplicationInstanceDependenciesInput, fn func(*ListApplicationInstanceDependenciesOutput, bool) bool) error { + return c.ListApplicationInstanceDependenciesPagesWithContext(aws.BackgroundContext(), input, fn) +} + +// ListApplicationInstanceDependenciesPagesWithContext same as ListApplicationInstanceDependenciesPages except +// it takes a Context and allows setting request options on the pages. +// +// The context must be non-nil and will be used for request cancellation. If +// the context is nil a panic will occur. In the future the SDK may create +// sub-contexts for http.Requests. See https://golang.org/pkg/context/ +// for more information on using Contexts. +func (c *Panorama) ListApplicationInstanceDependenciesPagesWithContext(ctx aws.Context, input *ListApplicationInstanceDependenciesInput, fn func(*ListApplicationInstanceDependenciesOutput, bool) bool, opts ...request.Option) error { + p := request.Pagination{ + NewRequest: func() (*request.Request, error) { + var inCpy *ListApplicationInstanceDependenciesInput + if input != nil { + tmp := *input + inCpy = &tmp + } + req, _ := c.ListApplicationInstanceDependenciesRequest(inCpy) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return req, nil + }, + } + + for p.Next() { + if !fn(p.Page().(*ListApplicationInstanceDependenciesOutput), !p.HasNextPage()) { + break + } + } + + return p.Err() +} + +const opListApplicationInstanceNodeInstances = "ListApplicationInstanceNodeInstances" + +// ListApplicationInstanceNodeInstancesRequest generates a "aws/request.Request" representing the +// client's request for the ListApplicationInstanceNodeInstances operation. The "output" return +// value will be populated with the request's response once the request completes +// successfully. +// +// Use "Send" method on the returned Request to send the API call to the service. +// the "output" return value is not valid until after Send returns without error. +// +// See ListApplicationInstanceNodeInstances for more information on using the ListApplicationInstanceNodeInstances +// API call, and error handling. +// +// This method is useful when you want to inject custom logic or configuration +// into the SDK's request lifecycle. Such as custom headers, or retry logic. +// +// +// // Example sending a request using the ListApplicationInstanceNodeInstancesRequest method. +// req, resp := client.ListApplicationInstanceNodeInstancesRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/panorama-2019-07-24/ListApplicationInstanceNodeInstances +func (c *Panorama) ListApplicationInstanceNodeInstancesRequest(input *ListApplicationInstanceNodeInstancesInput) (req *request.Request, output *ListApplicationInstanceNodeInstancesOutput) { + op := &request.Operation{ + Name: opListApplicationInstanceNodeInstances, + HTTPMethod: "GET", + HTTPPath: "/application-instances/{applicationInstanceId}/node-instances", + Paginator: &request.Paginator{ + InputTokens: []string{"NextToken"}, + OutputTokens: []string{"NextToken"}, + LimitToken: "MaxResults", + TruncationToken: "", + }, + } + + if input == nil { + input = &ListApplicationInstanceNodeInstancesInput{} + } + + output = &ListApplicationInstanceNodeInstancesOutput{} + req = c.newRequest(op, input, output) + return +} + +// ListApplicationInstanceNodeInstances API operation for AWS Panorama. +// +// Returns a list of application node instances. +// +// Returns awserr.Error for service API and SDK errors. Use runtime type assertions +// with awserr.Error's Code and Message methods to get detailed information about +// the error. +// +// See the AWS API reference guide for AWS Panorama's +// API operation ListApplicationInstanceNodeInstances for usage and error information. +// +// Returned Error Types: +// * AccessDeniedException +// The requestor does not have permission to access the target action or resource. +// +// * InternalServerException +// An internal error occurred. +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/panorama-2019-07-24/ListApplicationInstanceNodeInstances +func (c *Panorama) ListApplicationInstanceNodeInstances(input *ListApplicationInstanceNodeInstancesInput) (*ListApplicationInstanceNodeInstancesOutput, error) { + req, out := c.ListApplicationInstanceNodeInstancesRequest(input) + return out, req.Send() +} + +// ListApplicationInstanceNodeInstancesWithContext is the same as ListApplicationInstanceNodeInstances with the addition of +// the ability to pass a context and additional request options. +// +// See ListApplicationInstanceNodeInstances for details on how to use this API operation. +// +// The context must be non-nil and will be used for request cancellation. If +// the context is nil a panic will occur. In the future the SDK may create +// sub-contexts for http.Requests. See https://golang.org/pkg/context/ +// for more information on using Contexts. +func (c *Panorama) ListApplicationInstanceNodeInstancesWithContext(ctx aws.Context, input *ListApplicationInstanceNodeInstancesInput, opts ...request.Option) (*ListApplicationInstanceNodeInstancesOutput, error) { + req, out := c.ListApplicationInstanceNodeInstancesRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + +// ListApplicationInstanceNodeInstancesPages iterates over the pages of a ListApplicationInstanceNodeInstances operation, +// calling the "fn" function with the response data for each page. To stop +// iterating, return false from the fn function. +// +// See ListApplicationInstanceNodeInstances method for more information on how to use this operation. +// +// Note: This operation can generate multiple requests to a service. +// +// // Example iterating over at most 3 pages of a ListApplicationInstanceNodeInstances operation. +// pageNum := 0 +// err := client.ListApplicationInstanceNodeInstancesPages(params, +// func(page *panorama.ListApplicationInstanceNodeInstancesOutput, lastPage bool) bool { +// pageNum++ +// fmt.Println(page) +// return pageNum <= 3 +// }) +// +func (c *Panorama) ListApplicationInstanceNodeInstancesPages(input *ListApplicationInstanceNodeInstancesInput, fn func(*ListApplicationInstanceNodeInstancesOutput, bool) bool) error { + return c.ListApplicationInstanceNodeInstancesPagesWithContext(aws.BackgroundContext(), input, fn) +} + +// ListApplicationInstanceNodeInstancesPagesWithContext same as ListApplicationInstanceNodeInstancesPages except +// it takes a Context and allows setting request options on the pages. +// +// The context must be non-nil and will be used for request cancellation. If +// the context is nil a panic will occur. In the future the SDK may create +// sub-contexts for http.Requests. See https://golang.org/pkg/context/ +// for more information on using Contexts. +func (c *Panorama) ListApplicationInstanceNodeInstancesPagesWithContext(ctx aws.Context, input *ListApplicationInstanceNodeInstancesInput, fn func(*ListApplicationInstanceNodeInstancesOutput, bool) bool, opts ...request.Option) error { + p := request.Pagination{ + NewRequest: func() (*request.Request, error) { + var inCpy *ListApplicationInstanceNodeInstancesInput + if input != nil { + tmp := *input + inCpy = &tmp + } + req, _ := c.ListApplicationInstanceNodeInstancesRequest(inCpy) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return req, nil + }, + } + + for p.Next() { + if !fn(p.Page().(*ListApplicationInstanceNodeInstancesOutput), !p.HasNextPage()) { + break + } + } + + return p.Err() +} + +const opListApplicationInstances = "ListApplicationInstances" + +// ListApplicationInstancesRequest generates a "aws/request.Request" representing the +// client's request for the ListApplicationInstances operation. The "output" return +// value will be populated with the request's response once the request completes +// successfully. +// +// Use "Send" method on the returned Request to send the API call to the service. +// the "output" return value is not valid until after Send returns without error. +// +// See ListApplicationInstances for more information on using the ListApplicationInstances +// API call, and error handling. +// +// This method is useful when you want to inject custom logic or configuration +// into the SDK's request lifecycle. Such as custom headers, or retry logic. +// +// +// // Example sending a request using the ListApplicationInstancesRequest method. +// req, resp := client.ListApplicationInstancesRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/panorama-2019-07-24/ListApplicationInstances +func (c *Panorama) ListApplicationInstancesRequest(input *ListApplicationInstancesInput) (req *request.Request, output *ListApplicationInstancesOutput) { + op := &request.Operation{ + Name: opListApplicationInstances, + HTTPMethod: "GET", + HTTPPath: "/application-instances", + Paginator: &request.Paginator{ + InputTokens: []string{"NextToken"}, + OutputTokens: []string{"NextToken"}, + LimitToken: "MaxResults", + TruncationToken: "", + }, + } + + if input == nil { + input = &ListApplicationInstancesInput{} + } + + output = &ListApplicationInstancesOutput{} + req = c.newRequest(op, input, output) + return +} + +// ListApplicationInstances API operation for AWS Panorama. +// +// Returns a list of application instances. +// +// Returns awserr.Error for service API and SDK errors. Use runtime type assertions +// with awserr.Error's Code and Message methods to get detailed information about +// the error. +// +// See the AWS API reference guide for AWS Panorama's +// API operation ListApplicationInstances for usage and error information. +// +// Returned Error Types: +// * AccessDeniedException +// The requestor does not have permission to access the target action or resource. +// +// * InternalServerException +// An internal error occurred. +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/panorama-2019-07-24/ListApplicationInstances +func (c *Panorama) ListApplicationInstances(input *ListApplicationInstancesInput) (*ListApplicationInstancesOutput, error) { + req, out := c.ListApplicationInstancesRequest(input) + return out, req.Send() +} + +// ListApplicationInstancesWithContext is the same as ListApplicationInstances with the addition of +// the ability to pass a context and additional request options. +// +// See ListApplicationInstances for details on how to use this API operation. +// +// The context must be non-nil and will be used for request cancellation. If +// the context is nil a panic will occur. In the future the SDK may create +// sub-contexts for http.Requests. See https://golang.org/pkg/context/ +// for more information on using Contexts. +func (c *Panorama) ListApplicationInstancesWithContext(ctx aws.Context, input *ListApplicationInstancesInput, opts ...request.Option) (*ListApplicationInstancesOutput, error) { + req, out := c.ListApplicationInstancesRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + +// ListApplicationInstancesPages iterates over the pages of a ListApplicationInstances operation, +// calling the "fn" function with the response data for each page. To stop +// iterating, return false from the fn function. +// +// See ListApplicationInstances method for more information on how to use this operation. +// +// Note: This operation can generate multiple requests to a service. +// +// // Example iterating over at most 3 pages of a ListApplicationInstances operation. +// pageNum := 0 +// err := client.ListApplicationInstancesPages(params, +// func(page *panorama.ListApplicationInstancesOutput, lastPage bool) bool { +// pageNum++ +// fmt.Println(page) +// return pageNum <= 3 +// }) +// +func (c *Panorama) ListApplicationInstancesPages(input *ListApplicationInstancesInput, fn func(*ListApplicationInstancesOutput, bool) bool) error { + return c.ListApplicationInstancesPagesWithContext(aws.BackgroundContext(), input, fn) +} + +// ListApplicationInstancesPagesWithContext same as ListApplicationInstancesPages except +// it takes a Context and allows setting request options on the pages. +// +// The context must be non-nil and will be used for request cancellation. If +// the context is nil a panic will occur. In the future the SDK may create +// sub-contexts for http.Requests. See https://golang.org/pkg/context/ +// for more information on using Contexts. +func (c *Panorama) ListApplicationInstancesPagesWithContext(ctx aws.Context, input *ListApplicationInstancesInput, fn func(*ListApplicationInstancesOutput, bool) bool, opts ...request.Option) error { + p := request.Pagination{ + NewRequest: func() (*request.Request, error) { + var inCpy *ListApplicationInstancesInput + if input != nil { + tmp := *input + inCpy = &tmp + } + req, _ := c.ListApplicationInstancesRequest(inCpy) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return req, nil + }, + } + + for p.Next() { + if !fn(p.Page().(*ListApplicationInstancesOutput), !p.HasNextPage()) { + break + } + } + + return p.Err() +} + +const opListDevices = "ListDevices" + +// ListDevicesRequest generates a "aws/request.Request" representing the +// client's request for the ListDevices operation. The "output" return +// value will be populated with the request's response once the request completes +// successfully. +// +// Use "Send" method on the returned Request to send the API call to the service. +// the "output" return value is not valid until after Send returns without error. +// +// See ListDevices for more information on using the ListDevices +// API call, and error handling. +// +// This method is useful when you want to inject custom logic or configuration +// into the SDK's request lifecycle. Such as custom headers, or retry logic. +// +// +// // Example sending a request using the ListDevicesRequest method. +// req, resp := client.ListDevicesRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/panorama-2019-07-24/ListDevices +func (c *Panorama) ListDevicesRequest(input *ListDevicesInput) (req *request.Request, output *ListDevicesOutput) { + op := &request.Operation{ + Name: opListDevices, + HTTPMethod: "GET", + HTTPPath: "/devices", + Paginator: &request.Paginator{ + InputTokens: []string{"NextToken"}, + OutputTokens: []string{"NextToken"}, + LimitToken: "MaxResults", + TruncationToken: "", + }, + } + + if input == nil { + input = &ListDevicesInput{} + } + + output = &ListDevicesOutput{} + req = c.newRequest(op, input, output) + return +} + +// ListDevices API operation for AWS Panorama. +// +// Returns a list of devices. +// +// Returns awserr.Error for service API and SDK errors. Use runtime type assertions +// with awserr.Error's Code and Message methods to get detailed information about +// the error. +// +// See the AWS API reference guide for AWS Panorama's +// API operation ListDevices for usage and error information. +// +// Returned Error Types: +// * ConflictException +// The target resource is in use. +// +// * ValidationException +// The request contains an invalid parameter value. +// +// * InternalServerException +// An internal error occurred. +// +// * AccessDeniedException +// The requestor does not have permission to access the target action or resource. +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/panorama-2019-07-24/ListDevices +func (c *Panorama) ListDevices(input *ListDevicesInput) (*ListDevicesOutput, error) { + req, out := c.ListDevicesRequest(input) + return out, req.Send() +} + +// ListDevicesWithContext is the same as ListDevices with the addition of +// the ability to pass a context and additional request options. +// +// See ListDevices for details on how to use this API operation. +// +// The context must be non-nil and will be used for request cancellation. If +// the context is nil a panic will occur. In the future the SDK may create +// sub-contexts for http.Requests. See https://golang.org/pkg/context/ +// for more information on using Contexts. +func (c *Panorama) ListDevicesWithContext(ctx aws.Context, input *ListDevicesInput, opts ...request.Option) (*ListDevicesOutput, error) { + req, out := c.ListDevicesRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + +// ListDevicesPages iterates over the pages of a ListDevices operation, +// calling the "fn" function with the response data for each page. To stop +// iterating, return false from the fn function. +// +// See ListDevices method for more information on how to use this operation. +// +// Note: This operation can generate multiple requests to a service. +// +// // Example iterating over at most 3 pages of a ListDevices operation. +// pageNum := 0 +// err := client.ListDevicesPages(params, +// func(page *panorama.ListDevicesOutput, lastPage bool) bool { +// pageNum++ +// fmt.Println(page) +// return pageNum <= 3 +// }) +// +func (c *Panorama) ListDevicesPages(input *ListDevicesInput, fn func(*ListDevicesOutput, bool) bool) error { + return c.ListDevicesPagesWithContext(aws.BackgroundContext(), input, fn) +} + +// ListDevicesPagesWithContext same as ListDevicesPages except +// it takes a Context and allows setting request options on the pages. +// +// The context must be non-nil and will be used for request cancellation. If +// the context is nil a panic will occur. In the future the SDK may create +// sub-contexts for http.Requests. See https://golang.org/pkg/context/ +// for more information on using Contexts. +func (c *Panorama) ListDevicesPagesWithContext(ctx aws.Context, input *ListDevicesInput, fn func(*ListDevicesOutput, bool) bool, opts ...request.Option) error { + p := request.Pagination{ + NewRequest: func() (*request.Request, error) { + var inCpy *ListDevicesInput + if input != nil { + tmp := *input + inCpy = &tmp + } + req, _ := c.ListDevicesRequest(inCpy) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return req, nil + }, + } + + for p.Next() { + if !fn(p.Page().(*ListDevicesOutput), !p.HasNextPage()) { + break + } + } + + return p.Err() +} + +const opListDevicesJobs = "ListDevicesJobs" + +// ListDevicesJobsRequest generates a "aws/request.Request" representing the +// client's request for the ListDevicesJobs operation. The "output" return +// value will be populated with the request's response once the request completes +// successfully. +// +// Use "Send" method on the returned Request to send the API call to the service. +// the "output" return value is not valid until after Send returns without error. +// +// See ListDevicesJobs for more information on using the ListDevicesJobs +// API call, and error handling. +// +// This method is useful when you want to inject custom logic or configuration +// into the SDK's request lifecycle. Such as custom headers, or retry logic. +// +// +// // Example sending a request using the ListDevicesJobsRequest method. +// req, resp := client.ListDevicesJobsRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/panorama-2019-07-24/ListDevicesJobs +func (c *Panorama) ListDevicesJobsRequest(input *ListDevicesJobsInput) (req *request.Request, output *ListDevicesJobsOutput) { + op := &request.Operation{ + Name: opListDevicesJobs, + HTTPMethod: "GET", + HTTPPath: "/jobs", + Paginator: &request.Paginator{ + InputTokens: []string{"NextToken"}, + OutputTokens: []string{"NextToken"}, + LimitToken: "MaxResults", + TruncationToken: "", + }, + } + + if input == nil { + input = &ListDevicesJobsInput{} + } + + output = &ListDevicesJobsOutput{} + req = c.newRequest(op, input, output) + return +} + +// ListDevicesJobs API operation for AWS Panorama. +// +// Returns a list of jobs. +// +// Returns awserr.Error for service API and SDK errors. Use runtime type assertions +// with awserr.Error's Code and Message methods to get detailed information about +// the error. +// +// See the AWS API reference guide for AWS Panorama's +// API operation ListDevicesJobs for usage and error information. +// +// Returned Error Types: +// * ConflictException +// The target resource is in use. +// +// * ValidationException +// The request contains an invalid parameter value. +// +// * InternalServerException +// An internal error occurred. +// +// * AccessDeniedException +// The requestor does not have permission to access the target action or resource. +// +// * ResourceNotFoundException +// The target resource was not found. +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/panorama-2019-07-24/ListDevicesJobs +func (c *Panorama) ListDevicesJobs(input *ListDevicesJobsInput) (*ListDevicesJobsOutput, error) { + req, out := c.ListDevicesJobsRequest(input) + return out, req.Send() +} + +// ListDevicesJobsWithContext is the same as ListDevicesJobs with the addition of +// the ability to pass a context and additional request options. +// +// See ListDevicesJobs for details on how to use this API operation. +// +// The context must be non-nil and will be used for request cancellation. If +// the context is nil a panic will occur. In the future the SDK may create +// sub-contexts for http.Requests. See https://golang.org/pkg/context/ +// for more information on using Contexts. +func (c *Panorama) ListDevicesJobsWithContext(ctx aws.Context, input *ListDevicesJobsInput, opts ...request.Option) (*ListDevicesJobsOutput, error) { + req, out := c.ListDevicesJobsRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + +// ListDevicesJobsPages iterates over the pages of a ListDevicesJobs operation, +// calling the "fn" function with the response data for each page. To stop +// iterating, return false from the fn function. +// +// See ListDevicesJobs method for more information on how to use this operation. +// +// Note: This operation can generate multiple requests to a service. +// +// // Example iterating over at most 3 pages of a ListDevicesJobs operation. +// pageNum := 0 +// err := client.ListDevicesJobsPages(params, +// func(page *panorama.ListDevicesJobsOutput, lastPage bool) bool { +// pageNum++ +// fmt.Println(page) +// return pageNum <= 3 +// }) +// +func (c *Panorama) ListDevicesJobsPages(input *ListDevicesJobsInput, fn func(*ListDevicesJobsOutput, bool) bool) error { + return c.ListDevicesJobsPagesWithContext(aws.BackgroundContext(), input, fn) +} + +// ListDevicesJobsPagesWithContext same as ListDevicesJobsPages except +// it takes a Context and allows setting request options on the pages. +// +// The context must be non-nil and will be used for request cancellation. If +// the context is nil a panic will occur. In the future the SDK may create +// sub-contexts for http.Requests. See https://golang.org/pkg/context/ +// for more information on using Contexts. +func (c *Panorama) ListDevicesJobsPagesWithContext(ctx aws.Context, input *ListDevicesJobsInput, fn func(*ListDevicesJobsOutput, bool) bool, opts ...request.Option) error { + p := request.Pagination{ + NewRequest: func() (*request.Request, error) { + var inCpy *ListDevicesJobsInput + if input != nil { + tmp := *input + inCpy = &tmp + } + req, _ := c.ListDevicesJobsRequest(inCpy) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return req, nil + }, + } + + for p.Next() { + if !fn(p.Page().(*ListDevicesJobsOutput), !p.HasNextPage()) { + break + } + } + + return p.Err() +} + +const opListNodeFromTemplateJobs = "ListNodeFromTemplateJobs" + +// ListNodeFromTemplateJobsRequest generates a "aws/request.Request" representing the +// client's request for the ListNodeFromTemplateJobs operation. The "output" return +// value will be populated with the request's response once the request completes +// successfully. +// +// Use "Send" method on the returned Request to send the API call to the service. +// the "output" return value is not valid until after Send returns without error. +// +// See ListNodeFromTemplateJobs for more information on using the ListNodeFromTemplateJobs +// API call, and error handling. +// +// This method is useful when you want to inject custom logic or configuration +// into the SDK's request lifecycle. Such as custom headers, or retry logic. +// +// +// // Example sending a request using the ListNodeFromTemplateJobsRequest method. +// req, resp := client.ListNodeFromTemplateJobsRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/panorama-2019-07-24/ListNodeFromTemplateJobs +func (c *Panorama) ListNodeFromTemplateJobsRequest(input *ListNodeFromTemplateJobsInput) (req *request.Request, output *ListNodeFromTemplateJobsOutput) { + op := &request.Operation{ + Name: opListNodeFromTemplateJobs, + HTTPMethod: "GET", + HTTPPath: "/packages/template-job", + Paginator: &request.Paginator{ + InputTokens: []string{"NextToken"}, + OutputTokens: []string{"NextToken"}, + LimitToken: "MaxResults", + TruncationToken: "", + }, + } + + if input == nil { + input = &ListNodeFromTemplateJobsInput{} + } + + output = &ListNodeFromTemplateJobsOutput{} + req = c.newRequest(op, input, output) + return +} + +// ListNodeFromTemplateJobs API operation for AWS Panorama. +// +// Returns a list of camera stream node jobs. +// +// Returns awserr.Error for service API and SDK errors. Use runtime type assertions +// with awserr.Error's Code and Message methods to get detailed information about +// the error. +// +// See the AWS API reference guide for AWS Panorama's +// API operation ListNodeFromTemplateJobs for usage and error information. +// +// Returned Error Types: +// * ValidationException +// The request contains an invalid parameter value. +// +// * InternalServerException +// An internal error occurred. +// +// * AccessDeniedException +// The requestor does not have permission to access the target action or resource. +// +// * ConflictException +// The target resource is in use. +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/panorama-2019-07-24/ListNodeFromTemplateJobs +func (c *Panorama) ListNodeFromTemplateJobs(input *ListNodeFromTemplateJobsInput) (*ListNodeFromTemplateJobsOutput, error) { + req, out := c.ListNodeFromTemplateJobsRequest(input) + return out, req.Send() +} + +// ListNodeFromTemplateJobsWithContext is the same as ListNodeFromTemplateJobs with the addition of +// the ability to pass a context and additional request options. +// +// See ListNodeFromTemplateJobs for details on how to use this API operation. +// +// The context must be non-nil and will be used for request cancellation. If +// the context is nil a panic will occur. In the future the SDK may create +// sub-contexts for http.Requests. See https://golang.org/pkg/context/ +// for more information on using Contexts. +func (c *Panorama) ListNodeFromTemplateJobsWithContext(ctx aws.Context, input *ListNodeFromTemplateJobsInput, opts ...request.Option) (*ListNodeFromTemplateJobsOutput, error) { + req, out := c.ListNodeFromTemplateJobsRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + +// ListNodeFromTemplateJobsPages iterates over the pages of a ListNodeFromTemplateJobs operation, +// calling the "fn" function with the response data for each page. To stop +// iterating, return false from the fn function. +// +// See ListNodeFromTemplateJobs method for more information on how to use this operation. +// +// Note: This operation can generate multiple requests to a service. +// +// // Example iterating over at most 3 pages of a ListNodeFromTemplateJobs operation. +// pageNum := 0 +// err := client.ListNodeFromTemplateJobsPages(params, +// func(page *panorama.ListNodeFromTemplateJobsOutput, lastPage bool) bool { +// pageNum++ +// fmt.Println(page) +// return pageNum <= 3 +// }) +// +func (c *Panorama) ListNodeFromTemplateJobsPages(input *ListNodeFromTemplateJobsInput, fn func(*ListNodeFromTemplateJobsOutput, bool) bool) error { + return c.ListNodeFromTemplateJobsPagesWithContext(aws.BackgroundContext(), input, fn) +} + +// ListNodeFromTemplateJobsPagesWithContext same as ListNodeFromTemplateJobsPages except +// it takes a Context and allows setting request options on the pages. +// +// The context must be non-nil and will be used for request cancellation. If +// the context is nil a panic will occur. In the future the SDK may create +// sub-contexts for http.Requests. See https://golang.org/pkg/context/ +// for more information on using Contexts. +func (c *Panorama) ListNodeFromTemplateJobsPagesWithContext(ctx aws.Context, input *ListNodeFromTemplateJobsInput, fn func(*ListNodeFromTemplateJobsOutput, bool) bool, opts ...request.Option) error { + p := request.Pagination{ + NewRequest: func() (*request.Request, error) { + var inCpy *ListNodeFromTemplateJobsInput + if input != nil { + tmp := *input + inCpy = &tmp + } + req, _ := c.ListNodeFromTemplateJobsRequest(inCpy) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return req, nil + }, + } + + for p.Next() { + if !fn(p.Page().(*ListNodeFromTemplateJobsOutput), !p.HasNextPage()) { + break + } + } + + return p.Err() +} + +const opListNodes = "ListNodes" + +// ListNodesRequest generates a "aws/request.Request" representing the +// client's request for the ListNodes operation. The "output" return +// value will be populated with the request's response once the request completes +// successfully. +// +// Use "Send" method on the returned Request to send the API call to the service. +// the "output" return value is not valid until after Send returns without error. +// +// See ListNodes for more information on using the ListNodes +// API call, and error handling. +// +// This method is useful when you want to inject custom logic or configuration +// into the SDK's request lifecycle. Such as custom headers, or retry logic. +// +// +// // Example sending a request using the ListNodesRequest method. +// req, resp := client.ListNodesRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/panorama-2019-07-24/ListNodes +func (c *Panorama) ListNodesRequest(input *ListNodesInput) (req *request.Request, output *ListNodesOutput) { + op := &request.Operation{ + Name: opListNodes, + HTTPMethod: "GET", + HTTPPath: "/nodes", + Paginator: &request.Paginator{ + InputTokens: []string{"NextToken"}, + OutputTokens: []string{"NextToken"}, + LimitToken: "MaxResults", + TruncationToken: "", + }, + } + + if input == nil { + input = &ListNodesInput{} + } + + output = &ListNodesOutput{} + req = c.newRequest(op, input, output) + return +} + +// ListNodes API operation for AWS Panorama. +// +// Returns a list of nodes. +// +// Returns awserr.Error for service API and SDK errors. Use runtime type assertions +// with awserr.Error's Code and Message methods to get detailed information about +// the error. +// +// See the AWS API reference guide for AWS Panorama's +// API operation ListNodes for usage and error information. +// +// Returned Error Types: +// * ConflictException +// The target resource is in use. +// +// * ValidationException +// The request contains an invalid parameter value. +// +// * InternalServerException +// An internal error occurred. +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/panorama-2019-07-24/ListNodes +func (c *Panorama) ListNodes(input *ListNodesInput) (*ListNodesOutput, error) { + req, out := c.ListNodesRequest(input) + return out, req.Send() +} + +// ListNodesWithContext is the same as ListNodes with the addition of +// the ability to pass a context and additional request options. +// +// See ListNodes for details on how to use this API operation. +// +// The context must be non-nil and will be used for request cancellation. If +// the context is nil a panic will occur. In the future the SDK may create +// sub-contexts for http.Requests. See https://golang.org/pkg/context/ +// for more information on using Contexts. +func (c *Panorama) ListNodesWithContext(ctx aws.Context, input *ListNodesInput, opts ...request.Option) (*ListNodesOutput, error) { + req, out := c.ListNodesRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + +// ListNodesPages iterates over the pages of a ListNodes operation, +// calling the "fn" function with the response data for each page. To stop +// iterating, return false from the fn function. +// +// See ListNodes method for more information on how to use this operation. +// +// Note: This operation can generate multiple requests to a service. +// +// // Example iterating over at most 3 pages of a ListNodes operation. +// pageNum := 0 +// err := client.ListNodesPages(params, +// func(page *panorama.ListNodesOutput, lastPage bool) bool { +// pageNum++ +// fmt.Println(page) +// return pageNum <= 3 +// }) +// +func (c *Panorama) ListNodesPages(input *ListNodesInput, fn func(*ListNodesOutput, bool) bool) error { + return c.ListNodesPagesWithContext(aws.BackgroundContext(), input, fn) +} + +// ListNodesPagesWithContext same as ListNodesPages except +// it takes a Context and allows setting request options on the pages. +// +// The context must be non-nil and will be used for request cancellation. If +// the context is nil a panic will occur. In the future the SDK may create +// sub-contexts for http.Requests. See https://golang.org/pkg/context/ +// for more information on using Contexts. +func (c *Panorama) ListNodesPagesWithContext(ctx aws.Context, input *ListNodesInput, fn func(*ListNodesOutput, bool) bool, opts ...request.Option) error { + p := request.Pagination{ + NewRequest: func() (*request.Request, error) { + var inCpy *ListNodesInput + if input != nil { + tmp := *input + inCpy = &tmp + } + req, _ := c.ListNodesRequest(inCpy) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return req, nil + }, + } + + for p.Next() { + if !fn(p.Page().(*ListNodesOutput), !p.HasNextPage()) { + break + } + } + + return p.Err() +} + +const opListPackageImportJobs = "ListPackageImportJobs" + +// ListPackageImportJobsRequest generates a "aws/request.Request" representing the +// client's request for the ListPackageImportJobs operation. The "output" return +// value will be populated with the request's response once the request completes +// successfully. +// +// Use "Send" method on the returned Request to send the API call to the service. +// the "output" return value is not valid until after Send returns without error. +// +// See ListPackageImportJobs for more information on using the ListPackageImportJobs +// API call, and error handling. +// +// This method is useful when you want to inject custom logic or configuration +// into the SDK's request lifecycle. Such as custom headers, or retry logic. +// +// +// // Example sending a request using the ListPackageImportJobsRequest method. +// req, resp := client.ListPackageImportJobsRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/panorama-2019-07-24/ListPackageImportJobs +func (c *Panorama) ListPackageImportJobsRequest(input *ListPackageImportJobsInput) (req *request.Request, output *ListPackageImportJobsOutput) { + op := &request.Operation{ + Name: opListPackageImportJobs, + HTTPMethod: "GET", + HTTPPath: "/packages/import-jobs", + Paginator: &request.Paginator{ + InputTokens: []string{"NextToken"}, + OutputTokens: []string{"NextToken"}, + LimitToken: "MaxResults", + TruncationToken: "", + }, + } + + if input == nil { + input = &ListPackageImportJobsInput{} + } + + output = &ListPackageImportJobsOutput{} + req = c.newRequest(op, input, output) + return +} + +// ListPackageImportJobs API operation for AWS Panorama. +// +// Returns a list of package import jobs. +// +// Returns awserr.Error for service API and SDK errors. Use runtime type assertions +// with awserr.Error's Code and Message methods to get detailed information about +// the error. +// +// See the AWS API reference guide for AWS Panorama's +// API operation ListPackageImportJobs for usage and error information. +// +// Returned Error Types: +// * ValidationException +// The request contains an invalid parameter value. +// +// * InternalServerException +// An internal error occurred. +// +// * AccessDeniedException +// The requestor does not have permission to access the target action or resource. +// +// * ConflictException +// The target resource is in use. +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/panorama-2019-07-24/ListPackageImportJobs +func (c *Panorama) ListPackageImportJobs(input *ListPackageImportJobsInput) (*ListPackageImportJobsOutput, error) { + req, out := c.ListPackageImportJobsRequest(input) + return out, req.Send() +} + +// ListPackageImportJobsWithContext is the same as ListPackageImportJobs with the addition of +// the ability to pass a context and additional request options. +// +// See ListPackageImportJobs for details on how to use this API operation. +// +// The context must be non-nil and will be used for request cancellation. If +// the context is nil a panic will occur. In the future the SDK may create +// sub-contexts for http.Requests. See https://golang.org/pkg/context/ +// for more information on using Contexts. +func (c *Panorama) ListPackageImportJobsWithContext(ctx aws.Context, input *ListPackageImportJobsInput, opts ...request.Option) (*ListPackageImportJobsOutput, error) { + req, out := c.ListPackageImportJobsRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + +// ListPackageImportJobsPages iterates over the pages of a ListPackageImportJobs operation, +// calling the "fn" function with the response data for each page. To stop +// iterating, return false from the fn function. +// +// See ListPackageImportJobs method for more information on how to use this operation. +// +// Note: This operation can generate multiple requests to a service. +// +// // Example iterating over at most 3 pages of a ListPackageImportJobs operation. +// pageNum := 0 +// err := client.ListPackageImportJobsPages(params, +// func(page *panorama.ListPackageImportJobsOutput, lastPage bool) bool { +// pageNum++ +// fmt.Println(page) +// return pageNum <= 3 +// }) +// +func (c *Panorama) ListPackageImportJobsPages(input *ListPackageImportJobsInput, fn func(*ListPackageImportJobsOutput, bool) bool) error { + return c.ListPackageImportJobsPagesWithContext(aws.BackgroundContext(), input, fn) +} + +// ListPackageImportJobsPagesWithContext same as ListPackageImportJobsPages except +// it takes a Context and allows setting request options on the pages. +// +// The context must be non-nil and will be used for request cancellation. If +// the context is nil a panic will occur. In the future the SDK may create +// sub-contexts for http.Requests. See https://golang.org/pkg/context/ +// for more information on using Contexts. +func (c *Panorama) ListPackageImportJobsPagesWithContext(ctx aws.Context, input *ListPackageImportJobsInput, fn func(*ListPackageImportJobsOutput, bool) bool, opts ...request.Option) error { + p := request.Pagination{ + NewRequest: func() (*request.Request, error) { + var inCpy *ListPackageImportJobsInput + if input != nil { + tmp := *input + inCpy = &tmp + } + req, _ := c.ListPackageImportJobsRequest(inCpy) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return req, nil + }, + } + + for p.Next() { + if !fn(p.Page().(*ListPackageImportJobsOutput), !p.HasNextPage()) { + break + } + } + + return p.Err() +} + +const opListPackages = "ListPackages" + +// ListPackagesRequest generates a "aws/request.Request" representing the +// client's request for the ListPackages operation. The "output" return +// value will be populated with the request's response once the request completes +// successfully. +// +// Use "Send" method on the returned Request to send the API call to the service. +// the "output" return value is not valid until after Send returns without error. +// +// See ListPackages for more information on using the ListPackages +// API call, and error handling. +// +// This method is useful when you want to inject custom logic or configuration +// into the SDK's request lifecycle. Such as custom headers, or retry logic. +// +// +// // Example sending a request using the ListPackagesRequest method. +// req, resp := client.ListPackagesRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/panorama-2019-07-24/ListPackages +func (c *Panorama) ListPackagesRequest(input *ListPackagesInput) (req *request.Request, output *ListPackagesOutput) { + op := &request.Operation{ + Name: opListPackages, + HTTPMethod: "GET", + HTTPPath: "/packages", + Paginator: &request.Paginator{ + InputTokens: []string{"NextToken"}, + OutputTokens: []string{"NextToken"}, + LimitToken: "MaxResults", + TruncationToken: "", + }, + } + + if input == nil { + input = &ListPackagesInput{} + } + + output = &ListPackagesOutput{} + req = c.newRequest(op, input, output) + return +} + +// ListPackages API operation for AWS Panorama. +// +// Returns a list of packages. +// +// Returns awserr.Error for service API and SDK errors. Use runtime type assertions +// with awserr.Error's Code and Message methods to get detailed information about +// the error. +// +// See the AWS API reference guide for AWS Panorama's +// API operation ListPackages for usage and error information. +// +// Returned Error Types: +// * ValidationException +// The request contains an invalid parameter value. +// +// * InternalServerException +// An internal error occurred. +// +// * AccessDeniedException +// The requestor does not have permission to access the target action or resource. +// +// * ConflictException +// The target resource is in use. +// +// * ResourceNotFoundException +// The target resource was not found. +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/panorama-2019-07-24/ListPackages +func (c *Panorama) ListPackages(input *ListPackagesInput) (*ListPackagesOutput, error) { + req, out := c.ListPackagesRequest(input) + return out, req.Send() +} + +// ListPackagesWithContext is the same as ListPackages with the addition of +// the ability to pass a context and additional request options. +// +// See ListPackages for details on how to use this API operation. +// +// The context must be non-nil and will be used for request cancellation. If +// the context is nil a panic will occur. In the future the SDK may create +// sub-contexts for http.Requests. See https://golang.org/pkg/context/ +// for more information on using Contexts. +func (c *Panorama) ListPackagesWithContext(ctx aws.Context, input *ListPackagesInput, opts ...request.Option) (*ListPackagesOutput, error) { + req, out := c.ListPackagesRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + +// ListPackagesPages iterates over the pages of a ListPackages operation, +// calling the "fn" function with the response data for each page. To stop +// iterating, return false from the fn function. +// +// See ListPackages method for more information on how to use this operation. +// +// Note: This operation can generate multiple requests to a service. +// +// // Example iterating over at most 3 pages of a ListPackages operation. +// pageNum := 0 +// err := client.ListPackagesPages(params, +// func(page *panorama.ListPackagesOutput, lastPage bool) bool { +// pageNum++ +// fmt.Println(page) +// return pageNum <= 3 +// }) +// +func (c *Panorama) ListPackagesPages(input *ListPackagesInput, fn func(*ListPackagesOutput, bool) bool) error { + return c.ListPackagesPagesWithContext(aws.BackgroundContext(), input, fn) +} + +// ListPackagesPagesWithContext same as ListPackagesPages except +// it takes a Context and allows setting request options on the pages. +// +// The context must be non-nil and will be used for request cancellation. If +// the context is nil a panic will occur. In the future the SDK may create +// sub-contexts for http.Requests. See https://golang.org/pkg/context/ +// for more information on using Contexts. +func (c *Panorama) ListPackagesPagesWithContext(ctx aws.Context, input *ListPackagesInput, fn func(*ListPackagesOutput, bool) bool, opts ...request.Option) error { + p := request.Pagination{ + NewRequest: func() (*request.Request, error) { + var inCpy *ListPackagesInput + if input != nil { + tmp := *input + inCpy = &tmp + } + req, _ := c.ListPackagesRequest(inCpy) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return req, nil + }, + } + + for p.Next() { + if !fn(p.Page().(*ListPackagesOutput), !p.HasNextPage()) { + break + } + } + + return p.Err() +} + +const opListTagsForResource = "ListTagsForResource" + +// ListTagsForResourceRequest generates a "aws/request.Request" representing the +// client's request for the ListTagsForResource operation. The "output" return +// value will be populated with the request's response once the request completes +// successfully. +// +// Use "Send" method on the returned Request to send the API call to the service. +// the "output" return value is not valid until after Send returns without error. +// +// See ListTagsForResource for more information on using the ListTagsForResource +// API call, and error handling. +// +// This method is useful when you want to inject custom logic or configuration +// into the SDK's request lifecycle. Such as custom headers, or retry logic. +// +// +// // Example sending a request using the ListTagsForResourceRequest method. +// req, resp := client.ListTagsForResourceRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/panorama-2019-07-24/ListTagsForResource +func (c *Panorama) ListTagsForResourceRequest(input *ListTagsForResourceInput) (req *request.Request, output *ListTagsForResourceOutput) { + op := &request.Operation{ + Name: opListTagsForResource, + HTTPMethod: "GET", + HTTPPath: "/tags/{ResourceArn}", + } + + if input == nil { + input = &ListTagsForResourceInput{} + } + + output = &ListTagsForResourceOutput{} + req = c.newRequest(op, input, output) + return +} + +// ListTagsForResource API operation for AWS Panorama. +// +// Returns a list of tags for a resource. +// +// Returns awserr.Error for service API and SDK errors. Use runtime type assertions +// with awserr.Error's Code and Message methods to get detailed information about +// the error. +// +// See the AWS API reference guide for AWS Panorama's +// API operation ListTagsForResource for usage and error information. +// +// Returned Error Types: +// * ResourceNotFoundException +// The target resource was not found. +// +// * ValidationException +// The request contains an invalid parameter value. +// +// * InternalServerException +// An internal error occurred. +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/panorama-2019-07-24/ListTagsForResource +func (c *Panorama) ListTagsForResource(input *ListTagsForResourceInput) (*ListTagsForResourceOutput, error) { + req, out := c.ListTagsForResourceRequest(input) + return out, req.Send() +} + +// ListTagsForResourceWithContext is the same as ListTagsForResource with the addition of +// the ability to pass a context and additional request options. +// +// See ListTagsForResource for details on how to use this API operation. +// +// The context must be non-nil and will be used for request cancellation. If +// the context is nil a panic will occur. In the future the SDK may create +// sub-contexts for http.Requests. See https://golang.org/pkg/context/ +// for more information on using Contexts. +func (c *Panorama) ListTagsForResourceWithContext(ctx aws.Context, input *ListTagsForResourceInput, opts ...request.Option) (*ListTagsForResourceOutput, error) { + req, out := c.ListTagsForResourceRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + +const opProvisionDevice = "ProvisionDevice" + +// ProvisionDeviceRequest generates a "aws/request.Request" representing the +// client's request for the ProvisionDevice operation. The "output" return +// value will be populated with the request's response once the request completes +// successfully. +// +// Use "Send" method on the returned Request to send the API call to the service. +// the "output" return value is not valid until after Send returns without error. +// +// See ProvisionDevice for more information on using the ProvisionDevice +// API call, and error handling. +// +// This method is useful when you want to inject custom logic or configuration +// into the SDK's request lifecycle. Such as custom headers, or retry logic. +// +// +// // Example sending a request using the ProvisionDeviceRequest method. +// req, resp := client.ProvisionDeviceRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/panorama-2019-07-24/ProvisionDevice +func (c *Panorama) ProvisionDeviceRequest(input *ProvisionDeviceInput) (req *request.Request, output *ProvisionDeviceOutput) { + op := &request.Operation{ + Name: opProvisionDevice, + HTTPMethod: "POST", + HTTPPath: "/devices", + } + + if input == nil { + input = &ProvisionDeviceInput{} + } + + output = &ProvisionDeviceOutput{} + req = c.newRequest(op, input, output) + return +} + +// ProvisionDevice API operation for AWS Panorama. +// +// Creates a device and returns a configuration archive. The configuration archive +// is a ZIP file that contains a provisioning certificate that is valid for +// 5 minutes. Transfer the configuration archive to the device with the included +// USB storage device within 5 minutes. +// +// Returns awserr.Error for service API and SDK errors. Use runtime type assertions +// with awserr.Error's Code and Message methods to get detailed information about +// the error. +// +// See the AWS API reference guide for AWS Panorama's +// API operation ProvisionDevice for usage and error information. +// +// Returned Error Types: +// * ConflictException +// The target resource is in use. +// +// * ValidationException +// The request contains an invalid parameter value. +// +// * InternalServerException +// An internal error occurred. +// +// * AccessDeniedException +// The requestor does not have permission to access the target action or resource. +// +// * ServiceQuotaExceededException +// The request would cause a limit to be exceeded. +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/panorama-2019-07-24/ProvisionDevice +func (c *Panorama) ProvisionDevice(input *ProvisionDeviceInput) (*ProvisionDeviceOutput, error) { + req, out := c.ProvisionDeviceRequest(input) + return out, req.Send() +} + +// ProvisionDeviceWithContext is the same as ProvisionDevice with the addition of +// the ability to pass a context and additional request options. +// +// See ProvisionDevice for details on how to use this API operation. +// +// The context must be non-nil and will be used for request cancellation. If +// the context is nil a panic will occur. In the future the SDK may create +// sub-contexts for http.Requests. See https://golang.org/pkg/context/ +// for more information on using Contexts. +func (c *Panorama) ProvisionDeviceWithContext(ctx aws.Context, input *ProvisionDeviceInput, opts ...request.Option) (*ProvisionDeviceOutput, error) { + req, out := c.ProvisionDeviceRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + +const opRegisterPackageVersion = "RegisterPackageVersion" + +// RegisterPackageVersionRequest generates a "aws/request.Request" representing the +// client's request for the RegisterPackageVersion operation. The "output" return +// value will be populated with the request's response once the request completes +// successfully. +// +// Use "Send" method on the returned Request to send the API call to the service. +// the "output" return value is not valid until after Send returns without error. +// +// See RegisterPackageVersion for more information on using the RegisterPackageVersion +// API call, and error handling. +// +// This method is useful when you want to inject custom logic or configuration +// into the SDK's request lifecycle. Such as custom headers, or retry logic. +// +// +// // Example sending a request using the RegisterPackageVersionRequest method. +// req, resp := client.RegisterPackageVersionRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/panorama-2019-07-24/RegisterPackageVersion +func (c *Panorama) RegisterPackageVersionRequest(input *RegisterPackageVersionInput) (req *request.Request, output *RegisterPackageVersionOutput) { + op := &request.Operation{ + Name: opRegisterPackageVersion, + HTTPMethod: "PUT", + HTTPPath: "/packages/{PackageId}/versions/{PackageVersion}/patch/{PatchVersion}", + } + + if input == nil { + input = &RegisterPackageVersionInput{} + } + + output = &RegisterPackageVersionOutput{} + req = c.newRequest(op, input, output) + req.Handlers.Unmarshal.Swap(restjson.UnmarshalHandler.Name, protocol.UnmarshalDiscardBodyHandler) + return +} + +// RegisterPackageVersion API operation for AWS Panorama. +// +// Registers a package version. +// +// Returns awserr.Error for service API and SDK errors. Use runtime type assertions +// with awserr.Error's Code and Message methods to get detailed information about +// the error. +// +// See the AWS API reference guide for AWS Panorama's +// API operation RegisterPackageVersion for usage and error information. +// +// Returned Error Types: +// * ValidationException +// The request contains an invalid parameter value. +// +// * InternalServerException +// An internal error occurred. +// +// * AccessDeniedException +// The requestor does not have permission to access the target action or resource. +// +// * ConflictException +// The target resource is in use. +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/panorama-2019-07-24/RegisterPackageVersion +func (c *Panorama) RegisterPackageVersion(input *RegisterPackageVersionInput) (*RegisterPackageVersionOutput, error) { + req, out := c.RegisterPackageVersionRequest(input) + return out, req.Send() +} + +// RegisterPackageVersionWithContext is the same as RegisterPackageVersion with the addition of +// the ability to pass a context and additional request options. +// +// See RegisterPackageVersion for details on how to use this API operation. +// +// The context must be non-nil and will be used for request cancellation. If +// the context is nil a panic will occur. In the future the SDK may create +// sub-contexts for http.Requests. See https://golang.org/pkg/context/ +// for more information on using Contexts. +func (c *Panorama) RegisterPackageVersionWithContext(ctx aws.Context, input *RegisterPackageVersionInput, opts ...request.Option) (*RegisterPackageVersionOutput, error) { + req, out := c.RegisterPackageVersionRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + +const opRemoveApplicationInstance = "RemoveApplicationInstance" + +// RemoveApplicationInstanceRequest generates a "aws/request.Request" representing the +// client's request for the RemoveApplicationInstance operation. The "output" return +// value will be populated with the request's response once the request completes +// successfully. +// +// Use "Send" method on the returned Request to send the API call to the service. +// the "output" return value is not valid until after Send returns without error. +// +// See RemoveApplicationInstance for more information on using the RemoveApplicationInstance +// API call, and error handling. +// +// This method is useful when you want to inject custom logic or configuration +// into the SDK's request lifecycle. Such as custom headers, or retry logic. +// +// +// // Example sending a request using the RemoveApplicationInstanceRequest method. +// req, resp := client.RemoveApplicationInstanceRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/panorama-2019-07-24/RemoveApplicationInstance +func (c *Panorama) RemoveApplicationInstanceRequest(input *RemoveApplicationInstanceInput) (req *request.Request, output *RemoveApplicationInstanceOutput) { + op := &request.Operation{ + Name: opRemoveApplicationInstance, + HTTPMethod: "DELETE", + HTTPPath: "/application-instances/{applicationInstanceId}", + } + + if input == nil { + input = &RemoveApplicationInstanceInput{} + } + + output = &RemoveApplicationInstanceOutput{} + req = c.newRequest(op, input, output) + req.Handlers.Unmarshal.Swap(restjson.UnmarshalHandler.Name, protocol.UnmarshalDiscardBodyHandler) + return +} + +// RemoveApplicationInstance API operation for AWS Panorama. +// +// Removes an application instance. +// +// Returns awserr.Error for service API and SDK errors. Use runtime type assertions +// with awserr.Error's Code and Message methods to get detailed information about +// the error. +// +// See the AWS API reference guide for AWS Panorama's +// API operation RemoveApplicationInstance for usage and error information. +// +// Returned Error Types: +// * ConflictException +// The target resource is in use. +// +// * ValidationException +// The request contains an invalid parameter value. +// +// * InternalServerException +// An internal error occurred. +// +// * AccessDeniedException +// The requestor does not have permission to access the target action or resource. +// +// * ResourceNotFoundException +// The target resource was not found. +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/panorama-2019-07-24/RemoveApplicationInstance +func (c *Panorama) RemoveApplicationInstance(input *RemoveApplicationInstanceInput) (*RemoveApplicationInstanceOutput, error) { + req, out := c.RemoveApplicationInstanceRequest(input) + return out, req.Send() +} + +// RemoveApplicationInstanceWithContext is the same as RemoveApplicationInstance with the addition of +// the ability to pass a context and additional request options. +// +// See RemoveApplicationInstance for details on how to use this API operation. +// +// The context must be non-nil and will be used for request cancellation. If +// the context is nil a panic will occur. In the future the SDK may create +// sub-contexts for http.Requests. See https://golang.org/pkg/context/ +// for more information on using Contexts. +func (c *Panorama) RemoveApplicationInstanceWithContext(ctx aws.Context, input *RemoveApplicationInstanceInput, opts ...request.Option) (*RemoveApplicationInstanceOutput, error) { + req, out := c.RemoveApplicationInstanceRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + +const opTagResource = "TagResource" + +// TagResourceRequest generates a "aws/request.Request" representing the +// client's request for the TagResource operation. The "output" return +// value will be populated with the request's response once the request completes +// successfully. +// +// Use "Send" method on the returned Request to send the API call to the service. +// the "output" return value is not valid until after Send returns without error. +// +// See TagResource for more information on using the TagResource +// API call, and error handling. +// +// This method is useful when you want to inject custom logic or configuration +// into the SDK's request lifecycle. Such as custom headers, or retry logic. +// +// +// // Example sending a request using the TagResourceRequest method. +// req, resp := client.TagResourceRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/panorama-2019-07-24/TagResource +func (c *Panorama) TagResourceRequest(input *TagResourceInput) (req *request.Request, output *TagResourceOutput) { + op := &request.Operation{ + Name: opTagResource, + HTTPMethod: "POST", + HTTPPath: "/tags/{ResourceArn}", + } + + if input == nil { + input = &TagResourceInput{} + } + + output = &TagResourceOutput{} + req = c.newRequest(op, input, output) + req.Handlers.Unmarshal.Swap(restjson.UnmarshalHandler.Name, protocol.UnmarshalDiscardBodyHandler) + return +} + +// TagResource API operation for AWS Panorama. +// +// Tags a resource. +// +// Returns awserr.Error for service API and SDK errors. Use runtime type assertions +// with awserr.Error's Code and Message methods to get detailed information about +// the error. +// +// See the AWS API reference guide for AWS Panorama's +// API operation TagResource for usage and error information. +// +// Returned Error Types: +// * ResourceNotFoundException +// The target resource was not found. +// +// * ValidationException +// The request contains an invalid parameter value. +// +// * InternalServerException +// An internal error occurred. +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/panorama-2019-07-24/TagResource +func (c *Panorama) TagResource(input *TagResourceInput) (*TagResourceOutput, error) { + req, out := c.TagResourceRequest(input) + return out, req.Send() +} + +// TagResourceWithContext is the same as TagResource with the addition of +// the ability to pass a context and additional request options. +// +// See TagResource for details on how to use this API operation. +// +// The context must be non-nil and will be used for request cancellation. If +// the context is nil a panic will occur. In the future the SDK may create +// sub-contexts for http.Requests. See https://golang.org/pkg/context/ +// for more information on using Contexts. +func (c *Panorama) TagResourceWithContext(ctx aws.Context, input *TagResourceInput, opts ...request.Option) (*TagResourceOutput, error) { + req, out := c.TagResourceRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + +const opUntagResource = "UntagResource" + +// UntagResourceRequest generates a "aws/request.Request" representing the +// client's request for the UntagResource operation. The "output" return +// value will be populated with the request's response once the request completes +// successfully. +// +// Use "Send" method on the returned Request to send the API call to the service. +// the "output" return value is not valid until after Send returns without error. +// +// See UntagResource for more information on using the UntagResource +// API call, and error handling. +// +// This method is useful when you want to inject custom logic or configuration +// into the SDK's request lifecycle. Such as custom headers, or retry logic. +// +// +// // Example sending a request using the UntagResourceRequest method. +// req, resp := client.UntagResourceRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/panorama-2019-07-24/UntagResource +func (c *Panorama) UntagResourceRequest(input *UntagResourceInput) (req *request.Request, output *UntagResourceOutput) { + op := &request.Operation{ + Name: opUntagResource, + HTTPMethod: "DELETE", + HTTPPath: "/tags/{ResourceArn}", + } + + if input == nil { + input = &UntagResourceInput{} + } + + output = &UntagResourceOutput{} + req = c.newRequest(op, input, output) + req.Handlers.Unmarshal.Swap(restjson.UnmarshalHandler.Name, protocol.UnmarshalDiscardBodyHandler) + return +} + +// UntagResource API operation for AWS Panorama. +// +// Removes tags from a resource. +// +// Returns awserr.Error for service API and SDK errors. Use runtime type assertions +// with awserr.Error's Code and Message methods to get detailed information about +// the error. +// +// See the AWS API reference guide for AWS Panorama's +// API operation UntagResource for usage and error information. +// +// Returned Error Types: +// * ResourceNotFoundException +// The target resource was not found. +// +// * ValidationException +// The request contains an invalid parameter value. +// +// * InternalServerException +// An internal error occurred. +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/panorama-2019-07-24/UntagResource +func (c *Panorama) UntagResource(input *UntagResourceInput) (*UntagResourceOutput, error) { + req, out := c.UntagResourceRequest(input) + return out, req.Send() +} + +// UntagResourceWithContext is the same as UntagResource with the addition of +// the ability to pass a context and additional request options. +// +// See UntagResource for details on how to use this API operation. +// +// The context must be non-nil and will be used for request cancellation. If +// the context is nil a panic will occur. In the future the SDK may create +// sub-contexts for http.Requests. See https://golang.org/pkg/context/ +// for more information on using Contexts. +func (c *Panorama) UntagResourceWithContext(ctx aws.Context, input *UntagResourceInput, opts ...request.Option) (*UntagResourceOutput, error) { + req, out := c.UntagResourceRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + +const opUpdateDeviceMetadata = "UpdateDeviceMetadata" + +// UpdateDeviceMetadataRequest generates a "aws/request.Request" representing the +// client's request for the UpdateDeviceMetadata operation. The "output" return +// value will be populated with the request's response once the request completes +// successfully. +// +// Use "Send" method on the returned Request to send the API call to the service. +// the "output" return value is not valid until after Send returns without error. +// +// See UpdateDeviceMetadata for more information on using the UpdateDeviceMetadata +// API call, and error handling. +// +// This method is useful when you want to inject custom logic or configuration +// into the SDK's request lifecycle. Such as custom headers, or retry logic. +// +// +// // Example sending a request using the UpdateDeviceMetadataRequest method. +// req, resp := client.UpdateDeviceMetadataRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/panorama-2019-07-24/UpdateDeviceMetadata +func (c *Panorama) UpdateDeviceMetadataRequest(input *UpdateDeviceMetadataInput) (req *request.Request, output *UpdateDeviceMetadataOutput) { + op := &request.Operation{ + Name: opUpdateDeviceMetadata, + HTTPMethod: "PUT", + HTTPPath: "/devices/{DeviceId}", + } + + if input == nil { + input = &UpdateDeviceMetadataInput{} + } + + output = &UpdateDeviceMetadataOutput{} + req = c.newRequest(op, input, output) + return +} + +// UpdateDeviceMetadata API operation for AWS Panorama. +// +// Updates a device's metadata. +// +// Returns awserr.Error for service API and SDK errors. Use runtime type assertions +// with awserr.Error's Code and Message methods to get detailed information about +// the error. +// +// See the AWS API reference guide for AWS Panorama's +// API operation UpdateDeviceMetadata for usage and error information. +// +// Returned Error Types: +// * ConflictException +// The target resource is in use. +// +// * ValidationException +// The request contains an invalid parameter value. +// +// * InternalServerException +// An internal error occurred. +// +// * AccessDeniedException +// The requestor does not have permission to access the target action or resource. +// +// * ResourceNotFoundException +// The target resource was not found. +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/panorama-2019-07-24/UpdateDeviceMetadata +func (c *Panorama) UpdateDeviceMetadata(input *UpdateDeviceMetadataInput) (*UpdateDeviceMetadataOutput, error) { + req, out := c.UpdateDeviceMetadataRequest(input) + return out, req.Send() +} + +// UpdateDeviceMetadataWithContext is the same as UpdateDeviceMetadata with the addition of +// the ability to pass a context and additional request options. +// +// See UpdateDeviceMetadata for details on how to use this API operation. +// +// The context must be non-nil and will be used for request cancellation. If +// the context is nil a panic will occur. In the future the SDK may create +// sub-contexts for http.Requests. See https://golang.org/pkg/context/ +// for more information on using Contexts. +func (c *Panorama) UpdateDeviceMetadataWithContext(ctx aws.Context, input *UpdateDeviceMetadataInput, opts ...request.Option) (*UpdateDeviceMetadataOutput, error) { + req, out := c.UpdateDeviceMetadataRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + +// The requestor does not have permission to access the target action or resource. +type AccessDeniedException struct { + _ struct{} `type:"structure"` + RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"` + + Message_ *string `locationName:"Message" type:"string"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s AccessDeniedException) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s AccessDeniedException) GoString() string { + return s.String() +} + +func newErrorAccessDeniedException(v protocol.ResponseMetadata) error { + return &AccessDeniedException{ + RespMetadata: v, + } +} + +// Code returns the exception type name. +func (s *AccessDeniedException) Code() string { + return "AccessDeniedException" +} + +// Message returns the exception's message. +func (s *AccessDeniedException) Message() string { + if s.Message_ != nil { + return *s.Message_ + } + return "" +} + +// OrigErr always returns nil, satisfies awserr.Error interface. +func (s *AccessDeniedException) OrigErr() error { + return nil +} + +func (s *AccessDeniedException) Error() string { + return fmt.Sprintf("%s: %s", s.Code(), s.Message()) +} + +// Status code returns the HTTP status code for the request's response error. +func (s *AccessDeniedException) StatusCode() int { + return s.RespMetadata.StatusCode +} + +// RequestID returns the service's response RequestID for request. +func (s *AccessDeniedException) RequestID() string { + return s.RespMetadata.RequestID +} + +// An application instance on a device. +type ApplicationInstance struct { + _ struct{} `type:"structure"` + + // The application instance's ID. + ApplicationInstanceId *string `min:"1" type:"string"` + + // The application instance's ARN. + Arn *string `min:"1" type:"string"` + + // When the application instance was created. + CreatedTime *time.Time `type:"timestamp"` + + // The device's ID. + DefaultRuntimeContextDevice *string `min:"1" type:"string"` + + // The device's name. + DefaultRuntimeContextDeviceName *string `min:"1" type:"string"` + + // The application instance's description. + Description *string `type:"string"` + + // The application instance's health status. + HealthStatus *string `type:"string" enum:"ApplicationInstanceHealthStatus"` + + // The application instance's name. + Name *string `min:"1" type:"string"` + + // The application instance's status. + Status *string `type:"string" enum:"ApplicationInstanceStatus"` + + // The application instance's status description. + StatusDescription *string `min:"1" type:"string"` + + // The application instance's tags. + Tags map[string]*string `type:"map"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ApplicationInstance) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ApplicationInstance) GoString() string { + return s.String() +} + +// SetApplicationInstanceId sets the ApplicationInstanceId field's value. +func (s *ApplicationInstance) SetApplicationInstanceId(v string) *ApplicationInstance { + s.ApplicationInstanceId = &v + return s +} + +// SetArn sets the Arn field's value. +func (s *ApplicationInstance) SetArn(v string) *ApplicationInstance { + s.Arn = &v + return s +} + +// SetCreatedTime sets the CreatedTime field's value. +func (s *ApplicationInstance) SetCreatedTime(v time.Time) *ApplicationInstance { + s.CreatedTime = &v + return s +} + +// SetDefaultRuntimeContextDevice sets the DefaultRuntimeContextDevice field's value. +func (s *ApplicationInstance) SetDefaultRuntimeContextDevice(v string) *ApplicationInstance { + s.DefaultRuntimeContextDevice = &v + return s +} + +// SetDefaultRuntimeContextDeviceName sets the DefaultRuntimeContextDeviceName field's value. +func (s *ApplicationInstance) SetDefaultRuntimeContextDeviceName(v string) *ApplicationInstance { + s.DefaultRuntimeContextDeviceName = &v + return s +} + +// SetDescription sets the Description field's value. +func (s *ApplicationInstance) SetDescription(v string) *ApplicationInstance { + s.Description = &v + return s +} + +// SetHealthStatus sets the HealthStatus field's value. +func (s *ApplicationInstance) SetHealthStatus(v string) *ApplicationInstance { + s.HealthStatus = &v + return s +} + +// SetName sets the Name field's value. +func (s *ApplicationInstance) SetName(v string) *ApplicationInstance { + s.Name = &v + return s +} + +// SetStatus sets the Status field's value. +func (s *ApplicationInstance) SetStatus(v string) *ApplicationInstance { + s.Status = &v + return s +} + +// SetStatusDescription sets the StatusDescription field's value. +func (s *ApplicationInstance) SetStatusDescription(v string) *ApplicationInstance { + s.StatusDescription = &v + return s +} + +// SetTags sets the Tags field's value. +func (s *ApplicationInstance) SetTags(v map[string]*string) *ApplicationInstance { + s.Tags = v + return s +} + +// The target resource is in use. +type ConflictException struct { + _ struct{} `type:"structure"` + RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"` + + // A list of attributes that led to the exception and their values. + ErrorArguments []*ConflictExceptionErrorArgument `type:"list"` + + // A unique ID for the error. + ErrorId *string `type:"string"` + + Message_ *string `locationName:"Message" type:"string"` + + // The resource's ID. + // + // ResourceId is a required field + ResourceId *string `type:"string" required:"true"` + + // The resource's type. + // + // ResourceType is a required field + ResourceType *string `type:"string" required:"true"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ConflictException) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ConflictException) GoString() string { + return s.String() +} + +func newErrorConflictException(v protocol.ResponseMetadata) error { + return &ConflictException{ + RespMetadata: v, + } +} + +// Code returns the exception type name. +func (s *ConflictException) Code() string { + return "ConflictException" +} + +// Message returns the exception's message. +func (s *ConflictException) Message() string { + if s.Message_ != nil { + return *s.Message_ + } + return "" +} + +// OrigErr always returns nil, satisfies awserr.Error interface. +func (s *ConflictException) OrigErr() error { + return nil +} + +func (s *ConflictException) Error() string { + return fmt.Sprintf("%s: %s\n%s", s.Code(), s.Message(), s.String()) +} + +// Status code returns the HTTP status code for the request's response error. +func (s *ConflictException) StatusCode() int { + return s.RespMetadata.StatusCode +} + +// RequestID returns the service's response RequestID for request. +func (s *ConflictException) RequestID() string { + return s.RespMetadata.RequestID +} + +// A conflict exception error argument. +type ConflictExceptionErrorArgument struct { + _ struct{} `type:"structure"` + + // The error argument's name. + // + // Name is a required field + Name *string `type:"string" required:"true"` + + // The error argument's value. + // + // Value is a required field + Value *string `type:"string" required:"true"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ConflictExceptionErrorArgument) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ConflictExceptionErrorArgument) GoString() string { + return s.String() +} + +// SetName sets the Name field's value. +func (s *ConflictExceptionErrorArgument) SetName(v string) *ConflictExceptionErrorArgument { + s.Name = &v + return s +} + +// SetValue sets the Value field's value. +func (s *ConflictExceptionErrorArgument) SetValue(v string) *ConflictExceptionErrorArgument { + s.Value = &v + return s +} + +type CreateApplicationInstanceInput struct { + _ struct{} `type:"structure"` + + // The ID of an application instance to replace with the new instance. + ApplicationInstanceIdToReplace *string `min:"1" type:"string"` + + // A device's ID. + // + // DefaultRuntimeContextDevice is a required field + DefaultRuntimeContextDevice *string `min:"1" type:"string" required:"true"` + + // A description for the application instance. + Description *string `type:"string"` + + // Setting overrides for the application manifest. + ManifestOverridesPayload *ManifestOverridesPayload `type:"structure"` + + // The application's manifest document. + // + // ManifestPayload is a required field + ManifestPayload *ManifestPayload `type:"structure" required:"true"` + + // A name for the application instance. + Name *string `min:"1" type:"string"` + + // The ARN of a runtime role for the application instance. + RuntimeRoleArn *string `min:"1" type:"string"` + + // Tags for the application instance. + Tags map[string]*string `type:"map"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s CreateApplicationInstanceInput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s CreateApplicationInstanceInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *CreateApplicationInstanceInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "CreateApplicationInstanceInput"} + if s.ApplicationInstanceIdToReplace != nil && len(*s.ApplicationInstanceIdToReplace) < 1 { + invalidParams.Add(request.NewErrParamMinLen("ApplicationInstanceIdToReplace", 1)) + } + if s.DefaultRuntimeContextDevice == nil { + invalidParams.Add(request.NewErrParamRequired("DefaultRuntimeContextDevice")) + } + if s.DefaultRuntimeContextDevice != nil && len(*s.DefaultRuntimeContextDevice) < 1 { + invalidParams.Add(request.NewErrParamMinLen("DefaultRuntimeContextDevice", 1)) + } + if s.ManifestPayload == nil { + invalidParams.Add(request.NewErrParamRequired("ManifestPayload")) + } + if s.Name != nil && len(*s.Name) < 1 { + invalidParams.Add(request.NewErrParamMinLen("Name", 1)) + } + if s.RuntimeRoleArn != nil && len(*s.RuntimeRoleArn) < 1 { + invalidParams.Add(request.NewErrParamMinLen("RuntimeRoleArn", 1)) + } + if s.ManifestPayload != nil { + if err := s.ManifestPayload.Validate(); err != nil { + invalidParams.AddNested("ManifestPayload", err.(request.ErrInvalidParams)) + } + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetApplicationInstanceIdToReplace sets the ApplicationInstanceIdToReplace field's value. +func (s *CreateApplicationInstanceInput) SetApplicationInstanceIdToReplace(v string) *CreateApplicationInstanceInput { + s.ApplicationInstanceIdToReplace = &v + return s +} + +// SetDefaultRuntimeContextDevice sets the DefaultRuntimeContextDevice field's value. +func (s *CreateApplicationInstanceInput) SetDefaultRuntimeContextDevice(v string) *CreateApplicationInstanceInput { + s.DefaultRuntimeContextDevice = &v + return s +} + +// SetDescription sets the Description field's value. +func (s *CreateApplicationInstanceInput) SetDescription(v string) *CreateApplicationInstanceInput { + s.Description = &v + return s +} + +// SetManifestOverridesPayload sets the ManifestOverridesPayload field's value. +func (s *CreateApplicationInstanceInput) SetManifestOverridesPayload(v *ManifestOverridesPayload) *CreateApplicationInstanceInput { + s.ManifestOverridesPayload = v + return s +} + +// SetManifestPayload sets the ManifestPayload field's value. +func (s *CreateApplicationInstanceInput) SetManifestPayload(v *ManifestPayload) *CreateApplicationInstanceInput { + s.ManifestPayload = v + return s +} + +// SetName sets the Name field's value. +func (s *CreateApplicationInstanceInput) SetName(v string) *CreateApplicationInstanceInput { + s.Name = &v + return s +} + +// SetRuntimeRoleArn sets the RuntimeRoleArn field's value. +func (s *CreateApplicationInstanceInput) SetRuntimeRoleArn(v string) *CreateApplicationInstanceInput { + s.RuntimeRoleArn = &v + return s +} + +// SetTags sets the Tags field's value. +func (s *CreateApplicationInstanceInput) SetTags(v map[string]*string) *CreateApplicationInstanceInput { + s.Tags = v + return s +} + +type CreateApplicationInstanceOutput struct { + _ struct{} `type:"structure"` + + // The application instance's ID. + // + // ApplicationInstanceId is a required field + ApplicationInstanceId *string `min:"1" type:"string" required:"true"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s CreateApplicationInstanceOutput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s CreateApplicationInstanceOutput) GoString() string { + return s.String() +} + +// SetApplicationInstanceId sets the ApplicationInstanceId field's value. +func (s *CreateApplicationInstanceOutput) SetApplicationInstanceId(v string) *CreateApplicationInstanceOutput { + s.ApplicationInstanceId = &v + return s +} + +type CreateJobForDevicesInput struct { + _ struct{} `type:"structure"` + + // IDs of target devices. + // + // DeviceIds is a required field + DeviceIds []*string `min:"1" type:"list" required:"true"` + + // Configuration settings for the job. + // + // DeviceJobConfig is a required field + DeviceJobConfig *DeviceJobConfig `type:"structure" required:"true"` + + // The type of job to run. + // + // JobType is a required field + JobType *string `type:"string" required:"true" enum:"JobType"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s CreateJobForDevicesInput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s CreateJobForDevicesInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *CreateJobForDevicesInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "CreateJobForDevicesInput"} + if s.DeviceIds == nil { + invalidParams.Add(request.NewErrParamRequired("DeviceIds")) + } + if s.DeviceIds != nil && len(s.DeviceIds) < 1 { + invalidParams.Add(request.NewErrParamMinLen("DeviceIds", 1)) + } + if s.DeviceJobConfig == nil { + invalidParams.Add(request.NewErrParamRequired("DeviceJobConfig")) + } + if s.JobType == nil { + invalidParams.Add(request.NewErrParamRequired("JobType")) + } + if s.DeviceJobConfig != nil { + if err := s.DeviceJobConfig.Validate(); err != nil { + invalidParams.AddNested("DeviceJobConfig", err.(request.ErrInvalidParams)) + } + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetDeviceIds sets the DeviceIds field's value. +func (s *CreateJobForDevicesInput) SetDeviceIds(v []*string) *CreateJobForDevicesInput { + s.DeviceIds = v + return s +} + +// SetDeviceJobConfig sets the DeviceJobConfig field's value. +func (s *CreateJobForDevicesInput) SetDeviceJobConfig(v *DeviceJobConfig) *CreateJobForDevicesInput { + s.DeviceJobConfig = v + return s +} + +// SetJobType sets the JobType field's value. +func (s *CreateJobForDevicesInput) SetJobType(v string) *CreateJobForDevicesInput { + s.JobType = &v + return s +} + +type CreateJobForDevicesOutput struct { + _ struct{} `type:"structure"` + + // A list of jobs. + // + // Jobs is a required field + Jobs []*Job `type:"list" required:"true"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s CreateJobForDevicesOutput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s CreateJobForDevicesOutput) GoString() string { + return s.String() +} + +// SetJobs sets the Jobs field's value. +func (s *CreateJobForDevicesOutput) SetJobs(v []*Job) *CreateJobForDevicesOutput { + s.Jobs = v + return s +} + +type CreateNodeFromTemplateJobInput struct { + _ struct{} `type:"structure"` + + // Tags for the job. + JobTags []*JobResourceTags `type:"list"` + + // A description for the node. + NodeDescription *string `type:"string"` + + // A name for the node. + // + // NodeName is a required field + NodeName *string `min:"1" type:"string" required:"true"` + + // An output package name for the node. + // + // OutputPackageName is a required field + OutputPackageName *string `min:"1" type:"string" required:"true"` + + // An output package version for the node. + // + // OutputPackageVersion is a required field + OutputPackageVersion *string `min:"1" type:"string" required:"true"` + + // Template parameters for the node. + // + // TemplateParameters is a required field + TemplateParameters map[string]*string `type:"map" required:"true"` + + // The type of node. + // + // TemplateType is a required field + TemplateType *string `type:"string" required:"true" enum:"TemplateType"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s CreateNodeFromTemplateJobInput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s CreateNodeFromTemplateJobInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *CreateNodeFromTemplateJobInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "CreateNodeFromTemplateJobInput"} + if s.NodeName == nil { + invalidParams.Add(request.NewErrParamRequired("NodeName")) + } + if s.NodeName != nil && len(*s.NodeName) < 1 { + invalidParams.Add(request.NewErrParamMinLen("NodeName", 1)) + } + if s.OutputPackageName == nil { + invalidParams.Add(request.NewErrParamRequired("OutputPackageName")) + } + if s.OutputPackageName != nil && len(*s.OutputPackageName) < 1 { + invalidParams.Add(request.NewErrParamMinLen("OutputPackageName", 1)) + } + if s.OutputPackageVersion == nil { + invalidParams.Add(request.NewErrParamRequired("OutputPackageVersion")) + } + if s.OutputPackageVersion != nil && len(*s.OutputPackageVersion) < 1 { + invalidParams.Add(request.NewErrParamMinLen("OutputPackageVersion", 1)) + } + if s.TemplateParameters == nil { + invalidParams.Add(request.NewErrParamRequired("TemplateParameters")) + } + if s.TemplateType == nil { + invalidParams.Add(request.NewErrParamRequired("TemplateType")) + } + if s.JobTags != nil { + for i, v := range s.JobTags { + if v == nil { + continue + } + if err := v.Validate(); err != nil { + invalidParams.AddNested(fmt.Sprintf("%s[%v]", "JobTags", i), err.(request.ErrInvalidParams)) + } + } + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetJobTags sets the JobTags field's value. +func (s *CreateNodeFromTemplateJobInput) SetJobTags(v []*JobResourceTags) *CreateNodeFromTemplateJobInput { + s.JobTags = v + return s +} + +// SetNodeDescription sets the NodeDescription field's value. +func (s *CreateNodeFromTemplateJobInput) SetNodeDescription(v string) *CreateNodeFromTemplateJobInput { + s.NodeDescription = &v + return s +} + +// SetNodeName sets the NodeName field's value. +func (s *CreateNodeFromTemplateJobInput) SetNodeName(v string) *CreateNodeFromTemplateJobInput { + s.NodeName = &v + return s +} + +// SetOutputPackageName sets the OutputPackageName field's value. +func (s *CreateNodeFromTemplateJobInput) SetOutputPackageName(v string) *CreateNodeFromTemplateJobInput { + s.OutputPackageName = &v + return s +} + +// SetOutputPackageVersion sets the OutputPackageVersion field's value. +func (s *CreateNodeFromTemplateJobInput) SetOutputPackageVersion(v string) *CreateNodeFromTemplateJobInput { + s.OutputPackageVersion = &v + return s +} + +// SetTemplateParameters sets the TemplateParameters field's value. +func (s *CreateNodeFromTemplateJobInput) SetTemplateParameters(v map[string]*string) *CreateNodeFromTemplateJobInput { + s.TemplateParameters = v + return s +} + +// SetTemplateType sets the TemplateType field's value. +func (s *CreateNodeFromTemplateJobInput) SetTemplateType(v string) *CreateNodeFromTemplateJobInput { + s.TemplateType = &v + return s +} + +type CreateNodeFromTemplateJobOutput struct { + _ struct{} `type:"structure"` + + // The job's ID. + // + // JobId is a required field + JobId *string `min:"1" type:"string" required:"true"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s CreateNodeFromTemplateJobOutput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s CreateNodeFromTemplateJobOutput) GoString() string { + return s.String() +} + +// SetJobId sets the JobId field's value. +func (s *CreateNodeFromTemplateJobOutput) SetJobId(v string) *CreateNodeFromTemplateJobOutput { + s.JobId = &v + return s +} + +type CreatePackageImportJobInput struct { + _ struct{} `type:"structure"` + + // A client token for the package import job. + // + // ClientToken is a required field + ClientToken *string `min:"1" type:"string" required:"true"` + + // An input config for the package import job. + // + // InputConfig is a required field + InputConfig *PackageImportJobInputConfig `type:"structure" required:"true"` + + // Tags for the package import job. + JobTags []*JobResourceTags `type:"list"` + + // A job type for the package import job. + // + // JobType is a required field + JobType *string `type:"string" required:"true" enum:"PackageImportJobType"` + + // An output config for the package import job. + // + // OutputConfig is a required field + OutputConfig *PackageImportJobOutputConfig `type:"structure" required:"true"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s CreatePackageImportJobInput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s CreatePackageImportJobInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *CreatePackageImportJobInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "CreatePackageImportJobInput"} + if s.ClientToken == nil { + invalidParams.Add(request.NewErrParamRequired("ClientToken")) + } + if s.ClientToken != nil && len(*s.ClientToken) < 1 { + invalidParams.Add(request.NewErrParamMinLen("ClientToken", 1)) + } + if s.InputConfig == nil { + invalidParams.Add(request.NewErrParamRequired("InputConfig")) + } + if s.JobType == nil { + invalidParams.Add(request.NewErrParamRequired("JobType")) + } + if s.OutputConfig == nil { + invalidParams.Add(request.NewErrParamRequired("OutputConfig")) + } + if s.InputConfig != nil { + if err := s.InputConfig.Validate(); err != nil { + invalidParams.AddNested("InputConfig", err.(request.ErrInvalidParams)) + } + } + if s.JobTags != nil { + for i, v := range s.JobTags { + if v == nil { + continue + } + if err := v.Validate(); err != nil { + invalidParams.AddNested(fmt.Sprintf("%s[%v]", "JobTags", i), err.(request.ErrInvalidParams)) + } + } + } + if s.OutputConfig != nil { + if err := s.OutputConfig.Validate(); err != nil { + invalidParams.AddNested("OutputConfig", err.(request.ErrInvalidParams)) + } + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetClientToken sets the ClientToken field's value. +func (s *CreatePackageImportJobInput) SetClientToken(v string) *CreatePackageImportJobInput { + s.ClientToken = &v + return s +} + +// SetInputConfig sets the InputConfig field's value. +func (s *CreatePackageImportJobInput) SetInputConfig(v *PackageImportJobInputConfig) *CreatePackageImportJobInput { + s.InputConfig = v + return s +} + +// SetJobTags sets the JobTags field's value. +func (s *CreatePackageImportJobInput) SetJobTags(v []*JobResourceTags) *CreatePackageImportJobInput { + s.JobTags = v + return s +} + +// SetJobType sets the JobType field's value. +func (s *CreatePackageImportJobInput) SetJobType(v string) *CreatePackageImportJobInput { + s.JobType = &v + return s +} + +// SetOutputConfig sets the OutputConfig field's value. +func (s *CreatePackageImportJobInput) SetOutputConfig(v *PackageImportJobOutputConfig) *CreatePackageImportJobInput { + s.OutputConfig = v + return s +} + +type CreatePackageImportJobOutput struct { + _ struct{} `type:"structure"` + + // The job's ID. + // + // JobId is a required field + JobId *string `min:"1" type:"string" required:"true"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s CreatePackageImportJobOutput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s CreatePackageImportJobOutput) GoString() string { + return s.String() +} + +// SetJobId sets the JobId field's value. +func (s *CreatePackageImportJobOutput) SetJobId(v string) *CreatePackageImportJobOutput { + s.JobId = &v + return s +} + +type CreatePackageInput struct { + _ struct{} `type:"structure"` + + // A name for the package. + // + // PackageName is a required field + PackageName *string `min:"1" type:"string" required:"true"` + + // Tags for the package. + Tags map[string]*string `type:"map"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s CreatePackageInput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s CreatePackageInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *CreatePackageInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "CreatePackageInput"} + if s.PackageName == nil { + invalidParams.Add(request.NewErrParamRequired("PackageName")) + } + if s.PackageName != nil && len(*s.PackageName) < 1 { + invalidParams.Add(request.NewErrParamMinLen("PackageName", 1)) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetPackageName sets the PackageName field's value. +func (s *CreatePackageInput) SetPackageName(v string) *CreatePackageInput { + s.PackageName = &v + return s +} + +// SetTags sets the Tags field's value. +func (s *CreatePackageInput) SetTags(v map[string]*string) *CreatePackageInput { + s.Tags = v + return s +} + +type CreatePackageOutput struct { + _ struct{} `type:"structure"` + + // The package's ARN. + Arn *string `min:"1" type:"string"` + + // The package's ID. + PackageId *string `min:"1" type:"string"` + + // The package's storage location. + // + // StorageLocation is a required field + StorageLocation *StorageLocation `type:"structure" required:"true"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s CreatePackageOutput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s CreatePackageOutput) GoString() string { + return s.String() +} + +// SetArn sets the Arn field's value. +func (s *CreatePackageOutput) SetArn(v string) *CreatePackageOutput { + s.Arn = &v + return s +} + +// SetPackageId sets the PackageId field's value. +func (s *CreatePackageOutput) SetPackageId(v string) *CreatePackageOutput { + s.PackageId = &v + return s +} + +// SetStorageLocation sets the StorageLocation field's value. +func (s *CreatePackageOutput) SetStorageLocation(v *StorageLocation) *CreatePackageOutput { + s.StorageLocation = v + return s +} + +type DeleteDeviceInput struct { + _ struct{} `type:"structure" nopayload:"true"` + + // The device's ID. + // + // DeviceId is a required field + DeviceId *string `location:"uri" locationName:"DeviceId" min:"1" type:"string" required:"true"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s DeleteDeviceInput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s DeleteDeviceInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *DeleteDeviceInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "DeleteDeviceInput"} + if s.DeviceId == nil { + invalidParams.Add(request.NewErrParamRequired("DeviceId")) + } + if s.DeviceId != nil && len(*s.DeviceId) < 1 { + invalidParams.Add(request.NewErrParamMinLen("DeviceId", 1)) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetDeviceId sets the DeviceId field's value. +func (s *DeleteDeviceInput) SetDeviceId(v string) *DeleteDeviceInput { + s.DeviceId = &v + return s +} + +type DeleteDeviceOutput struct { + _ struct{} `type:"structure"` + + // The device's ID. + DeviceId *string `min:"1" type:"string"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s DeleteDeviceOutput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s DeleteDeviceOutput) GoString() string { + return s.String() +} + +// SetDeviceId sets the DeviceId field's value. +func (s *DeleteDeviceOutput) SetDeviceId(v string) *DeleteDeviceOutput { + s.DeviceId = &v + return s +} + +type DeletePackageInput struct { + _ struct{} `type:"structure" nopayload:"true"` + + // Delete the package even if it has artifacts stored in its access point. Deletes + // the package's artifacts from Amazon S3. + ForceDelete *bool `location:"querystring" locationName:"ForceDelete" type:"boolean"` + + // The package's ID. + // + // PackageId is a required field + PackageId *string `location:"uri" locationName:"PackageId" min:"1" type:"string" required:"true"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s DeletePackageInput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s DeletePackageInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *DeletePackageInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "DeletePackageInput"} + if s.PackageId == nil { + invalidParams.Add(request.NewErrParamRequired("PackageId")) + } + if s.PackageId != nil && len(*s.PackageId) < 1 { + invalidParams.Add(request.NewErrParamMinLen("PackageId", 1)) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetForceDelete sets the ForceDelete field's value. +func (s *DeletePackageInput) SetForceDelete(v bool) *DeletePackageInput { + s.ForceDelete = &v + return s +} + +// SetPackageId sets the PackageId field's value. +func (s *DeletePackageInput) SetPackageId(v string) *DeletePackageInput { + s.PackageId = &v + return s +} + +type DeletePackageOutput struct { + _ struct{} `type:"structure"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s DeletePackageOutput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s DeletePackageOutput) GoString() string { + return s.String() +} + +type DeregisterPackageVersionInput struct { + _ struct{} `type:"structure" nopayload:"true"` + + // An owner account. + OwnerAccount *string `location:"querystring" locationName:"OwnerAccount" min:"1" type:"string"` + + // A package ID. + // + // PackageId is a required field + PackageId *string `location:"uri" locationName:"PackageId" min:"1" type:"string" required:"true"` + + // A package version. + // + // PackageVersion is a required field + PackageVersion *string `location:"uri" locationName:"PackageVersion" min:"1" type:"string" required:"true"` + + // A patch version. + // + // PatchVersion is a required field + PatchVersion *string `location:"uri" locationName:"PatchVersion" min:"1" type:"string" required:"true"` + + // If the version was marked latest, the new version to maker as latest. + UpdatedLatestPatchVersion *string `location:"querystring" locationName:"UpdatedLatestPatchVersion" min:"1" type:"string"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s DeregisterPackageVersionInput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s DeregisterPackageVersionInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *DeregisterPackageVersionInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "DeregisterPackageVersionInput"} + if s.OwnerAccount != nil && len(*s.OwnerAccount) < 1 { + invalidParams.Add(request.NewErrParamMinLen("OwnerAccount", 1)) + } + if s.PackageId == nil { + invalidParams.Add(request.NewErrParamRequired("PackageId")) + } + if s.PackageId != nil && len(*s.PackageId) < 1 { + invalidParams.Add(request.NewErrParamMinLen("PackageId", 1)) + } + if s.PackageVersion == nil { + invalidParams.Add(request.NewErrParamRequired("PackageVersion")) + } + if s.PackageVersion != nil && len(*s.PackageVersion) < 1 { + invalidParams.Add(request.NewErrParamMinLen("PackageVersion", 1)) + } + if s.PatchVersion == nil { + invalidParams.Add(request.NewErrParamRequired("PatchVersion")) + } + if s.PatchVersion != nil && len(*s.PatchVersion) < 1 { + invalidParams.Add(request.NewErrParamMinLen("PatchVersion", 1)) + } + if s.UpdatedLatestPatchVersion != nil && len(*s.UpdatedLatestPatchVersion) < 1 { + invalidParams.Add(request.NewErrParamMinLen("UpdatedLatestPatchVersion", 1)) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetOwnerAccount sets the OwnerAccount field's value. +func (s *DeregisterPackageVersionInput) SetOwnerAccount(v string) *DeregisterPackageVersionInput { + s.OwnerAccount = &v + return s +} + +// SetPackageId sets the PackageId field's value. +func (s *DeregisterPackageVersionInput) SetPackageId(v string) *DeregisterPackageVersionInput { + s.PackageId = &v + return s +} + +// SetPackageVersion sets the PackageVersion field's value. +func (s *DeregisterPackageVersionInput) SetPackageVersion(v string) *DeregisterPackageVersionInput { + s.PackageVersion = &v + return s +} + +// SetPatchVersion sets the PatchVersion field's value. +func (s *DeregisterPackageVersionInput) SetPatchVersion(v string) *DeregisterPackageVersionInput { + s.PatchVersion = &v + return s +} + +// SetUpdatedLatestPatchVersion sets the UpdatedLatestPatchVersion field's value. +func (s *DeregisterPackageVersionInput) SetUpdatedLatestPatchVersion(v string) *DeregisterPackageVersionInput { + s.UpdatedLatestPatchVersion = &v + return s +} + +type DeregisterPackageVersionOutput struct { + _ struct{} `type:"structure"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s DeregisterPackageVersionOutput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s DeregisterPackageVersionOutput) GoString() string { + return s.String() +} + +type DescribeApplicationInstanceDetailsInput struct { + _ struct{} `type:"structure" nopayload:"true"` + + // The application instance's ID. + // + // ApplicationInstanceId is a required field + ApplicationInstanceId *string `location:"uri" locationName:"applicationInstanceId" min:"1" type:"string" required:"true"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s DescribeApplicationInstanceDetailsInput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s DescribeApplicationInstanceDetailsInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *DescribeApplicationInstanceDetailsInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "DescribeApplicationInstanceDetailsInput"} + if s.ApplicationInstanceId == nil { + invalidParams.Add(request.NewErrParamRequired("ApplicationInstanceId")) + } + if s.ApplicationInstanceId != nil && len(*s.ApplicationInstanceId) < 1 { + invalidParams.Add(request.NewErrParamMinLen("ApplicationInstanceId", 1)) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetApplicationInstanceId sets the ApplicationInstanceId field's value. +func (s *DescribeApplicationInstanceDetailsInput) SetApplicationInstanceId(v string) *DescribeApplicationInstanceDetailsInput { + s.ApplicationInstanceId = &v + return s +} + +type DescribeApplicationInstanceDetailsOutput struct { + _ struct{} `type:"structure"` + + // The application instance's ID. + ApplicationInstanceId *string `min:"1" type:"string"` + + // The ID of the application instance that this instance replaced. + ApplicationInstanceIdToReplace *string `min:"1" type:"string"` + + // When the application instance was created. + CreatedTime *time.Time `type:"timestamp"` + + // The application instance's default runtime context device. + DefaultRuntimeContextDevice *string `min:"1" type:"string"` + + // The application instance's description. + Description *string `type:"string"` + + // Parameter overrides for the configuration manifest. + ManifestOverridesPayload *ManifestOverridesPayload `type:"structure"` + + // The application instance's configuration manifest. + ManifestPayload *ManifestPayload `type:"structure"` + + // The application instance's name. + Name *string `min:"1" type:"string"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s DescribeApplicationInstanceDetailsOutput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s DescribeApplicationInstanceDetailsOutput) GoString() string { + return s.String() +} + +// SetApplicationInstanceId sets the ApplicationInstanceId field's value. +func (s *DescribeApplicationInstanceDetailsOutput) SetApplicationInstanceId(v string) *DescribeApplicationInstanceDetailsOutput { + s.ApplicationInstanceId = &v + return s +} + +// SetApplicationInstanceIdToReplace sets the ApplicationInstanceIdToReplace field's value. +func (s *DescribeApplicationInstanceDetailsOutput) SetApplicationInstanceIdToReplace(v string) *DescribeApplicationInstanceDetailsOutput { + s.ApplicationInstanceIdToReplace = &v + return s +} + +// SetCreatedTime sets the CreatedTime field's value. +func (s *DescribeApplicationInstanceDetailsOutput) SetCreatedTime(v time.Time) *DescribeApplicationInstanceDetailsOutput { + s.CreatedTime = &v + return s +} + +// SetDefaultRuntimeContextDevice sets the DefaultRuntimeContextDevice field's value. +func (s *DescribeApplicationInstanceDetailsOutput) SetDefaultRuntimeContextDevice(v string) *DescribeApplicationInstanceDetailsOutput { + s.DefaultRuntimeContextDevice = &v + return s +} + +// SetDescription sets the Description field's value. +func (s *DescribeApplicationInstanceDetailsOutput) SetDescription(v string) *DescribeApplicationInstanceDetailsOutput { + s.Description = &v + return s +} + +// SetManifestOverridesPayload sets the ManifestOverridesPayload field's value. +func (s *DescribeApplicationInstanceDetailsOutput) SetManifestOverridesPayload(v *ManifestOverridesPayload) *DescribeApplicationInstanceDetailsOutput { + s.ManifestOverridesPayload = v + return s +} + +// SetManifestPayload sets the ManifestPayload field's value. +func (s *DescribeApplicationInstanceDetailsOutput) SetManifestPayload(v *ManifestPayload) *DescribeApplicationInstanceDetailsOutput { + s.ManifestPayload = v + return s +} + +// SetName sets the Name field's value. +func (s *DescribeApplicationInstanceDetailsOutput) SetName(v string) *DescribeApplicationInstanceDetailsOutput { + s.Name = &v + return s +} + +type DescribeApplicationInstanceInput struct { + _ struct{} `type:"structure" nopayload:"true"` + + // The application instance's ID. + // + // ApplicationInstanceId is a required field + ApplicationInstanceId *string `location:"uri" locationName:"applicationInstanceId" min:"1" type:"string" required:"true"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s DescribeApplicationInstanceInput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s DescribeApplicationInstanceInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *DescribeApplicationInstanceInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "DescribeApplicationInstanceInput"} + if s.ApplicationInstanceId == nil { + invalidParams.Add(request.NewErrParamRequired("ApplicationInstanceId")) + } + if s.ApplicationInstanceId != nil && len(*s.ApplicationInstanceId) < 1 { + invalidParams.Add(request.NewErrParamMinLen("ApplicationInstanceId", 1)) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetApplicationInstanceId sets the ApplicationInstanceId field's value. +func (s *DescribeApplicationInstanceInput) SetApplicationInstanceId(v string) *DescribeApplicationInstanceInput { + s.ApplicationInstanceId = &v + return s +} + +type DescribeApplicationInstanceOutput struct { + _ struct{} `type:"structure"` + + // The application instance's ID. + ApplicationInstanceId *string `min:"1" type:"string"` + + // The ID of the application instance that this instance replaced. + ApplicationInstanceIdToReplace *string `min:"1" type:"string"` + + // The application instance's ARN. + Arn *string `min:"1" type:"string"` + + // When the application instance was created. + CreatedTime *time.Time `type:"timestamp"` + + // The device's ID. + DefaultRuntimeContextDevice *string `min:"1" type:"string"` + + // The device's bane. + DefaultRuntimeContextDeviceName *string `min:"1" type:"string"` + + // The application instance's description. + Description *string `type:"string"` + + // The application instance's health status. + HealthStatus *string `type:"string" enum:"ApplicationInstanceHealthStatus"` + + // The application instance was updated. + LastUpdatedTime *time.Time `type:"timestamp"` + + // The application instance's name. + Name *string `min:"1" type:"string"` + + // The application instance's runtime role ARN. + RuntimeRoleArn *string `min:"1" type:"string"` + + // The application instance's status. + Status *string `type:"string" enum:"ApplicationInstanceStatus"` + + // The application instance's status description. + StatusDescription *string `min:"1" type:"string"` + + // The application instance's tags. + Tags map[string]*string `type:"map"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s DescribeApplicationInstanceOutput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s DescribeApplicationInstanceOutput) GoString() string { + return s.String() +} + +// SetApplicationInstanceId sets the ApplicationInstanceId field's value. +func (s *DescribeApplicationInstanceOutput) SetApplicationInstanceId(v string) *DescribeApplicationInstanceOutput { + s.ApplicationInstanceId = &v + return s +} + +// SetApplicationInstanceIdToReplace sets the ApplicationInstanceIdToReplace field's value. +func (s *DescribeApplicationInstanceOutput) SetApplicationInstanceIdToReplace(v string) *DescribeApplicationInstanceOutput { + s.ApplicationInstanceIdToReplace = &v + return s +} + +// SetArn sets the Arn field's value. +func (s *DescribeApplicationInstanceOutput) SetArn(v string) *DescribeApplicationInstanceOutput { + s.Arn = &v + return s +} + +// SetCreatedTime sets the CreatedTime field's value. +func (s *DescribeApplicationInstanceOutput) SetCreatedTime(v time.Time) *DescribeApplicationInstanceOutput { + s.CreatedTime = &v + return s +} + +// SetDefaultRuntimeContextDevice sets the DefaultRuntimeContextDevice field's value. +func (s *DescribeApplicationInstanceOutput) SetDefaultRuntimeContextDevice(v string) *DescribeApplicationInstanceOutput { + s.DefaultRuntimeContextDevice = &v + return s +} + +// SetDefaultRuntimeContextDeviceName sets the DefaultRuntimeContextDeviceName field's value. +func (s *DescribeApplicationInstanceOutput) SetDefaultRuntimeContextDeviceName(v string) *DescribeApplicationInstanceOutput { + s.DefaultRuntimeContextDeviceName = &v + return s +} + +// SetDescription sets the Description field's value. +func (s *DescribeApplicationInstanceOutput) SetDescription(v string) *DescribeApplicationInstanceOutput { + s.Description = &v + return s +} + +// SetHealthStatus sets the HealthStatus field's value. +func (s *DescribeApplicationInstanceOutput) SetHealthStatus(v string) *DescribeApplicationInstanceOutput { + s.HealthStatus = &v + return s +} + +// SetLastUpdatedTime sets the LastUpdatedTime field's value. +func (s *DescribeApplicationInstanceOutput) SetLastUpdatedTime(v time.Time) *DescribeApplicationInstanceOutput { + s.LastUpdatedTime = &v + return s +} + +// SetName sets the Name field's value. +func (s *DescribeApplicationInstanceOutput) SetName(v string) *DescribeApplicationInstanceOutput { + s.Name = &v + return s +} + +// SetRuntimeRoleArn sets the RuntimeRoleArn field's value. +func (s *DescribeApplicationInstanceOutput) SetRuntimeRoleArn(v string) *DescribeApplicationInstanceOutput { + s.RuntimeRoleArn = &v + return s +} + +// SetStatus sets the Status field's value. +func (s *DescribeApplicationInstanceOutput) SetStatus(v string) *DescribeApplicationInstanceOutput { + s.Status = &v + return s +} + +// SetStatusDescription sets the StatusDescription field's value. +func (s *DescribeApplicationInstanceOutput) SetStatusDescription(v string) *DescribeApplicationInstanceOutput { + s.StatusDescription = &v + return s +} + +// SetTags sets the Tags field's value. +func (s *DescribeApplicationInstanceOutput) SetTags(v map[string]*string) *DescribeApplicationInstanceOutput { + s.Tags = v + return s +} + +type DescribeDeviceInput struct { + _ struct{} `type:"structure" nopayload:"true"` + + // The device's ID. + // + // DeviceId is a required field + DeviceId *string `location:"uri" locationName:"DeviceId" min:"1" type:"string" required:"true"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s DescribeDeviceInput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s DescribeDeviceInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *DescribeDeviceInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "DescribeDeviceInput"} + if s.DeviceId == nil { + invalidParams.Add(request.NewErrParamRequired("DeviceId")) + } + if s.DeviceId != nil && len(*s.DeviceId) < 1 { + invalidParams.Add(request.NewErrParamMinLen("DeviceId", 1)) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetDeviceId sets the DeviceId field's value. +func (s *DescribeDeviceInput) SetDeviceId(v string) *DescribeDeviceInput { + s.DeviceId = &v + return s +} + +type DescribeDeviceJobInput struct { + _ struct{} `type:"structure" nopayload:"true"` + + // The job's ID. + // + // JobId is a required field + JobId *string `location:"uri" locationName:"JobId" min:"1" type:"string" required:"true"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s DescribeDeviceJobInput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s DescribeDeviceJobInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *DescribeDeviceJobInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "DescribeDeviceJobInput"} + if s.JobId == nil { + invalidParams.Add(request.NewErrParamRequired("JobId")) + } + if s.JobId != nil && len(*s.JobId) < 1 { + invalidParams.Add(request.NewErrParamMinLen("JobId", 1)) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetJobId sets the JobId field's value. +func (s *DescribeDeviceJobInput) SetJobId(v string) *DescribeDeviceJobInput { + s.JobId = &v + return s +} + +type DescribeDeviceJobOutput struct { + _ struct{} `type:"structure"` + + // When the job was created. + CreatedTime *time.Time `type:"timestamp"` + + // The device's ARN. + DeviceArn *string `min:"1" type:"string"` + + // The device's ID. + DeviceId *string `min:"1" type:"string"` + + // The device's name. + DeviceName *string `min:"1" type:"string"` + + // The device's type. + DeviceType *string `type:"string" enum:"DeviceType"` + + // For an OTA job, the target version of the device software. + ImageVersion *string `min:"1" type:"string"` + + // The job's ID. + JobId *string `min:"1" type:"string"` + + // The job's status. + Status *string `type:"string" enum:"UpdateProgress"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s DescribeDeviceJobOutput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s DescribeDeviceJobOutput) GoString() string { + return s.String() +} + +// SetCreatedTime sets the CreatedTime field's value. +func (s *DescribeDeviceJobOutput) SetCreatedTime(v time.Time) *DescribeDeviceJobOutput { + s.CreatedTime = &v + return s +} + +// SetDeviceArn sets the DeviceArn field's value. +func (s *DescribeDeviceJobOutput) SetDeviceArn(v string) *DescribeDeviceJobOutput { + s.DeviceArn = &v + return s +} + +// SetDeviceId sets the DeviceId field's value. +func (s *DescribeDeviceJobOutput) SetDeviceId(v string) *DescribeDeviceJobOutput { + s.DeviceId = &v + return s +} + +// SetDeviceName sets the DeviceName field's value. +func (s *DescribeDeviceJobOutput) SetDeviceName(v string) *DescribeDeviceJobOutput { + s.DeviceName = &v + return s +} + +// SetDeviceType sets the DeviceType field's value. +func (s *DescribeDeviceJobOutput) SetDeviceType(v string) *DescribeDeviceJobOutput { + s.DeviceType = &v + return s +} + +// SetImageVersion sets the ImageVersion field's value. +func (s *DescribeDeviceJobOutput) SetImageVersion(v string) *DescribeDeviceJobOutput { + s.ImageVersion = &v + return s +} + +// SetJobId sets the JobId field's value. +func (s *DescribeDeviceJobOutput) SetJobId(v string) *DescribeDeviceJobOutput { + s.JobId = &v + return s +} + +// SetStatus sets the Status field's value. +func (s *DescribeDeviceJobOutput) SetStatus(v string) *DescribeDeviceJobOutput { + s.Status = &v + return s +} + +type DescribeDeviceOutput struct { + _ struct{} `type:"structure"` + + // The device's ARN. + Arn *string `min:"1" type:"string"` + + // When the device was created. + CreatedTime *time.Time `type:"timestamp"` + + // The device's networking status. + CurrentNetworkingStatus *NetworkStatus `type:"structure"` + + // The device's current software version. + CurrentSoftware *string `min:"1" type:"string"` + + // The device's description. + Description *string `type:"string"` + + // The device's connection status. + DeviceConnectionStatus *string `type:"string" enum:"DeviceConnectionStatus"` + + // The device's ID. + DeviceId *string `min:"1" type:"string"` + + // The latest software version available for the device. + LatestSoftware *string `min:"1" type:"string"` + + // The device's lease expiration time. + LeaseExpirationTime *time.Time `type:"timestamp"` + + // The device's name. + Name *string `min:"1" type:"string"` + + // The device's networking configuration. + NetworkingConfiguration *NetworkPayload `type:"structure"` + + // The device's provisioning status. + ProvisioningStatus *string `type:"string" enum:"DeviceStatus"` + + // The device's serial number. + SerialNumber *string `type:"string"` + + // The device's tags. + Tags map[string]*string `type:"map"` + + // The device's type. + Type *string `type:"string" enum:"DeviceType"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s DescribeDeviceOutput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s DescribeDeviceOutput) GoString() string { + return s.String() +} + +// SetArn sets the Arn field's value. +func (s *DescribeDeviceOutput) SetArn(v string) *DescribeDeviceOutput { + s.Arn = &v + return s +} + +// SetCreatedTime sets the CreatedTime field's value. +func (s *DescribeDeviceOutput) SetCreatedTime(v time.Time) *DescribeDeviceOutput { + s.CreatedTime = &v + return s +} + +// SetCurrentNetworkingStatus sets the CurrentNetworkingStatus field's value. +func (s *DescribeDeviceOutput) SetCurrentNetworkingStatus(v *NetworkStatus) *DescribeDeviceOutput { + s.CurrentNetworkingStatus = v + return s +} + +// SetCurrentSoftware sets the CurrentSoftware field's value. +func (s *DescribeDeviceOutput) SetCurrentSoftware(v string) *DescribeDeviceOutput { + s.CurrentSoftware = &v + return s +} + +// SetDescription sets the Description field's value. +func (s *DescribeDeviceOutput) SetDescription(v string) *DescribeDeviceOutput { + s.Description = &v + return s +} + +// SetDeviceConnectionStatus sets the DeviceConnectionStatus field's value. +func (s *DescribeDeviceOutput) SetDeviceConnectionStatus(v string) *DescribeDeviceOutput { + s.DeviceConnectionStatus = &v + return s +} + +// SetDeviceId sets the DeviceId field's value. +func (s *DescribeDeviceOutput) SetDeviceId(v string) *DescribeDeviceOutput { + s.DeviceId = &v + return s +} + +// SetLatestSoftware sets the LatestSoftware field's value. +func (s *DescribeDeviceOutput) SetLatestSoftware(v string) *DescribeDeviceOutput { + s.LatestSoftware = &v + return s +} + +// SetLeaseExpirationTime sets the LeaseExpirationTime field's value. +func (s *DescribeDeviceOutput) SetLeaseExpirationTime(v time.Time) *DescribeDeviceOutput { + s.LeaseExpirationTime = &v + return s +} + +// SetName sets the Name field's value. +func (s *DescribeDeviceOutput) SetName(v string) *DescribeDeviceOutput { + s.Name = &v + return s +} + +// SetNetworkingConfiguration sets the NetworkingConfiguration field's value. +func (s *DescribeDeviceOutput) SetNetworkingConfiguration(v *NetworkPayload) *DescribeDeviceOutput { + s.NetworkingConfiguration = v + return s +} + +// SetProvisioningStatus sets the ProvisioningStatus field's value. +func (s *DescribeDeviceOutput) SetProvisioningStatus(v string) *DescribeDeviceOutput { + s.ProvisioningStatus = &v + return s +} + +// SetSerialNumber sets the SerialNumber field's value. +func (s *DescribeDeviceOutput) SetSerialNumber(v string) *DescribeDeviceOutput { + s.SerialNumber = &v + return s +} + +// SetTags sets the Tags field's value. +func (s *DescribeDeviceOutput) SetTags(v map[string]*string) *DescribeDeviceOutput { + s.Tags = v + return s +} + +// SetType sets the Type field's value. +func (s *DescribeDeviceOutput) SetType(v string) *DescribeDeviceOutput { + s.Type = &v + return s +} + +type DescribeNodeFromTemplateJobInput struct { + _ struct{} `type:"structure" nopayload:"true"` + + // The job's ID. + // + // JobId is a required field + JobId *string `location:"uri" locationName:"JobId" min:"1" type:"string" required:"true"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s DescribeNodeFromTemplateJobInput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s DescribeNodeFromTemplateJobInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *DescribeNodeFromTemplateJobInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "DescribeNodeFromTemplateJobInput"} + if s.JobId == nil { + invalidParams.Add(request.NewErrParamRequired("JobId")) + } + if s.JobId != nil && len(*s.JobId) < 1 { + invalidParams.Add(request.NewErrParamMinLen("JobId", 1)) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetJobId sets the JobId field's value. +func (s *DescribeNodeFromTemplateJobInput) SetJobId(v string) *DescribeNodeFromTemplateJobInput { + s.JobId = &v + return s +} + +type DescribeNodeFromTemplateJobOutput struct { + _ struct{} `type:"structure"` + + // When the job was created. + // + // CreatedTime is a required field + CreatedTime *time.Time `type:"timestamp" required:"true"` + + // The job's ID. + // + // JobId is a required field + JobId *string `min:"1" type:"string" required:"true"` + + // The job's tags. + JobTags []*JobResourceTags `type:"list"` + + // When the job was updated. + // + // LastUpdatedTime is a required field + LastUpdatedTime *time.Time `type:"timestamp" required:"true"` + + // The node's description. + NodeDescription *string `type:"string"` + + // The node's name. + // + // NodeName is a required field + NodeName *string `min:"1" type:"string" required:"true"` + + // The job's output package name. + // + // OutputPackageName is a required field + OutputPackageName *string `min:"1" type:"string" required:"true"` + + // The job's output package version. + // + // OutputPackageVersion is a required field + OutputPackageVersion *string `min:"1" type:"string" required:"true"` + + // The job's status. + // + // Status is a required field + Status *string `type:"string" required:"true" enum:"NodeFromTemplateJobStatus"` + + // The job's status message. + // + // StatusMessage is a required field + StatusMessage *string `type:"string" required:"true"` + + // The job's template parameters. + // + // TemplateParameters is a required field + TemplateParameters map[string]*string `type:"map" required:"true"` + + // The job's template type. + // + // TemplateType is a required field + TemplateType *string `type:"string" required:"true" enum:"TemplateType"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s DescribeNodeFromTemplateJobOutput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s DescribeNodeFromTemplateJobOutput) GoString() string { + return s.String() +} + +// SetCreatedTime sets the CreatedTime field's value. +func (s *DescribeNodeFromTemplateJobOutput) SetCreatedTime(v time.Time) *DescribeNodeFromTemplateJobOutput { + s.CreatedTime = &v + return s +} + +// SetJobId sets the JobId field's value. +func (s *DescribeNodeFromTemplateJobOutput) SetJobId(v string) *DescribeNodeFromTemplateJobOutput { + s.JobId = &v + return s +} + +// SetJobTags sets the JobTags field's value. +func (s *DescribeNodeFromTemplateJobOutput) SetJobTags(v []*JobResourceTags) *DescribeNodeFromTemplateJobOutput { + s.JobTags = v + return s +} + +// SetLastUpdatedTime sets the LastUpdatedTime field's value. +func (s *DescribeNodeFromTemplateJobOutput) SetLastUpdatedTime(v time.Time) *DescribeNodeFromTemplateJobOutput { + s.LastUpdatedTime = &v + return s +} + +// SetNodeDescription sets the NodeDescription field's value. +func (s *DescribeNodeFromTemplateJobOutput) SetNodeDescription(v string) *DescribeNodeFromTemplateJobOutput { + s.NodeDescription = &v + return s +} + +// SetNodeName sets the NodeName field's value. +func (s *DescribeNodeFromTemplateJobOutput) SetNodeName(v string) *DescribeNodeFromTemplateJobOutput { + s.NodeName = &v + return s +} + +// SetOutputPackageName sets the OutputPackageName field's value. +func (s *DescribeNodeFromTemplateJobOutput) SetOutputPackageName(v string) *DescribeNodeFromTemplateJobOutput { + s.OutputPackageName = &v + return s +} + +// SetOutputPackageVersion sets the OutputPackageVersion field's value. +func (s *DescribeNodeFromTemplateJobOutput) SetOutputPackageVersion(v string) *DescribeNodeFromTemplateJobOutput { + s.OutputPackageVersion = &v + return s +} + +// SetStatus sets the Status field's value. +func (s *DescribeNodeFromTemplateJobOutput) SetStatus(v string) *DescribeNodeFromTemplateJobOutput { + s.Status = &v + return s +} + +// SetStatusMessage sets the StatusMessage field's value. +func (s *DescribeNodeFromTemplateJobOutput) SetStatusMessage(v string) *DescribeNodeFromTemplateJobOutput { + s.StatusMessage = &v + return s +} + +// SetTemplateParameters sets the TemplateParameters field's value. +func (s *DescribeNodeFromTemplateJobOutput) SetTemplateParameters(v map[string]*string) *DescribeNodeFromTemplateJobOutput { + s.TemplateParameters = v + return s +} + +// SetTemplateType sets the TemplateType field's value. +func (s *DescribeNodeFromTemplateJobOutput) SetTemplateType(v string) *DescribeNodeFromTemplateJobOutput { + s.TemplateType = &v + return s +} + +type DescribeNodeInput struct { + _ struct{} `type:"structure" nopayload:"true"` + + // The node's ID. + // + // NodeId is a required field + NodeId *string `location:"uri" locationName:"NodeId" min:"1" type:"string" required:"true"` + + // The account ID of the node's owner. + OwnerAccount *string `location:"querystring" locationName:"OwnerAccount" min:"1" type:"string"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s DescribeNodeInput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s DescribeNodeInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *DescribeNodeInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "DescribeNodeInput"} + if s.NodeId == nil { + invalidParams.Add(request.NewErrParamRequired("NodeId")) + } + if s.NodeId != nil && len(*s.NodeId) < 1 { + invalidParams.Add(request.NewErrParamMinLen("NodeId", 1)) + } + if s.OwnerAccount != nil && len(*s.OwnerAccount) < 1 { + invalidParams.Add(request.NewErrParamMinLen("OwnerAccount", 1)) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetNodeId sets the NodeId field's value. +func (s *DescribeNodeInput) SetNodeId(v string) *DescribeNodeInput { + s.NodeId = &v + return s +} + +// SetOwnerAccount sets the OwnerAccount field's value. +func (s *DescribeNodeInput) SetOwnerAccount(v string) *DescribeNodeInput { + s.OwnerAccount = &v + return s +} + +type DescribeNodeOutput struct { + _ struct{} `type:"structure"` + + // The node's asset name. + AssetName *string `min:"1" type:"string"` + + // The node's category. + // + // Category is a required field + Category *string `type:"string" required:"true" enum:"NodeCategory"` + + // When the node was created. + // + // CreatedTime is a required field + CreatedTime *time.Time `type:"timestamp" required:"true"` + + // The node's description. + // + // Description is a required field + Description *string `type:"string" required:"true"` + + // When the node was updated. + // + // LastUpdatedTime is a required field + LastUpdatedTime *time.Time `type:"timestamp" required:"true"` + + // The node's name. + // + // Name is a required field + Name *string `min:"1" type:"string" required:"true"` + + // The node's ID. + // + // NodeId is a required field + NodeId *string `min:"1" type:"string" required:"true"` + + // The node's interface. + // + // NodeInterface is a required field + NodeInterface *NodeInterface `type:"structure" required:"true"` + + // The account ID of the node's owner. + // + // OwnerAccount is a required field + OwnerAccount *string `min:"1" type:"string" required:"true"` + + // The node's ARN. + PackageArn *string `min:"1" type:"string"` + + // The node's package ID. + // + // PackageId is a required field + PackageId *string `min:"1" type:"string" required:"true"` + + // The node's package name. + // + // PackageName is a required field + PackageName *string `min:"1" type:"string" required:"true"` + + // The node's package version. + // + // PackageVersion is a required field + PackageVersion *string `min:"1" type:"string" required:"true"` + + // The node's patch version. + // + // PatchVersion is a required field + PatchVersion *string `min:"1" type:"string" required:"true"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s DescribeNodeOutput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s DescribeNodeOutput) GoString() string { + return s.String() +} + +// SetAssetName sets the AssetName field's value. +func (s *DescribeNodeOutput) SetAssetName(v string) *DescribeNodeOutput { + s.AssetName = &v + return s +} + +// SetCategory sets the Category field's value. +func (s *DescribeNodeOutput) SetCategory(v string) *DescribeNodeOutput { + s.Category = &v + return s +} + +// SetCreatedTime sets the CreatedTime field's value. +func (s *DescribeNodeOutput) SetCreatedTime(v time.Time) *DescribeNodeOutput { + s.CreatedTime = &v + return s +} + +// SetDescription sets the Description field's value. +func (s *DescribeNodeOutput) SetDescription(v string) *DescribeNodeOutput { + s.Description = &v + return s +} + +// SetLastUpdatedTime sets the LastUpdatedTime field's value. +func (s *DescribeNodeOutput) SetLastUpdatedTime(v time.Time) *DescribeNodeOutput { + s.LastUpdatedTime = &v + return s +} + +// SetName sets the Name field's value. +func (s *DescribeNodeOutput) SetName(v string) *DescribeNodeOutput { + s.Name = &v + return s +} + +// SetNodeId sets the NodeId field's value. +func (s *DescribeNodeOutput) SetNodeId(v string) *DescribeNodeOutput { + s.NodeId = &v + return s +} + +// SetNodeInterface sets the NodeInterface field's value. +func (s *DescribeNodeOutput) SetNodeInterface(v *NodeInterface) *DescribeNodeOutput { + s.NodeInterface = v + return s +} + +// SetOwnerAccount sets the OwnerAccount field's value. +func (s *DescribeNodeOutput) SetOwnerAccount(v string) *DescribeNodeOutput { + s.OwnerAccount = &v + return s +} + +// SetPackageArn sets the PackageArn field's value. +func (s *DescribeNodeOutput) SetPackageArn(v string) *DescribeNodeOutput { + s.PackageArn = &v + return s +} + +// SetPackageId sets the PackageId field's value. +func (s *DescribeNodeOutput) SetPackageId(v string) *DescribeNodeOutput { + s.PackageId = &v + return s +} + +// SetPackageName sets the PackageName field's value. +func (s *DescribeNodeOutput) SetPackageName(v string) *DescribeNodeOutput { + s.PackageName = &v + return s +} + +// SetPackageVersion sets the PackageVersion field's value. +func (s *DescribeNodeOutput) SetPackageVersion(v string) *DescribeNodeOutput { + s.PackageVersion = &v + return s +} + +// SetPatchVersion sets the PatchVersion field's value. +func (s *DescribeNodeOutput) SetPatchVersion(v string) *DescribeNodeOutput { + s.PatchVersion = &v + return s +} + +type DescribePackageImportJobInput struct { + _ struct{} `type:"structure" nopayload:"true"` + + // The job's ID. + // + // JobId is a required field + JobId *string `location:"uri" locationName:"JobId" min:"1" type:"string" required:"true"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s DescribePackageImportJobInput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s DescribePackageImportJobInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *DescribePackageImportJobInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "DescribePackageImportJobInput"} + if s.JobId == nil { + invalidParams.Add(request.NewErrParamRequired("JobId")) + } + if s.JobId != nil && len(*s.JobId) < 1 { + invalidParams.Add(request.NewErrParamMinLen("JobId", 1)) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetJobId sets the JobId field's value. +func (s *DescribePackageImportJobInput) SetJobId(v string) *DescribePackageImportJobInput { + s.JobId = &v + return s +} + +type DescribePackageImportJobOutput struct { + _ struct{} `type:"structure"` + + // The job's client token. + ClientToken *string `min:"1" type:"string"` + + // When the job was created. + // + // CreatedTime is a required field + CreatedTime *time.Time `type:"timestamp" required:"true"` + + // The job's input config. + // + // InputConfig is a required field + InputConfig *PackageImportJobInputConfig `type:"structure" required:"true"` + + // The job's ID. + // + // JobId is a required field + JobId *string `min:"1" type:"string" required:"true"` + + // The job's tags. + JobTags []*JobResourceTags `type:"list"` + + // The job's type. + // + // JobType is a required field + JobType *string `type:"string" required:"true" enum:"PackageImportJobType"` + + // When the job was updated. + // + // LastUpdatedTime is a required field + LastUpdatedTime *time.Time `type:"timestamp" required:"true"` + + // The job's output. + // + // Output is a required field + Output *PackageImportJobOutput_ `type:"structure" required:"true"` + + // The job's output config. + // + // OutputConfig is a required field + OutputConfig *PackageImportJobOutputConfig `type:"structure" required:"true"` + + // The job's status. + // + // Status is a required field + Status *string `type:"string" required:"true" enum:"PackageImportJobStatus"` + + // The job's status message. + // + // StatusMessage is a required field + StatusMessage *string `type:"string" required:"true"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s DescribePackageImportJobOutput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s DescribePackageImportJobOutput) GoString() string { + return s.String() +} + +// SetClientToken sets the ClientToken field's value. +func (s *DescribePackageImportJobOutput) SetClientToken(v string) *DescribePackageImportJobOutput { + s.ClientToken = &v + return s +} + +// SetCreatedTime sets the CreatedTime field's value. +func (s *DescribePackageImportJobOutput) SetCreatedTime(v time.Time) *DescribePackageImportJobOutput { + s.CreatedTime = &v + return s +} + +// SetInputConfig sets the InputConfig field's value. +func (s *DescribePackageImportJobOutput) SetInputConfig(v *PackageImportJobInputConfig) *DescribePackageImportJobOutput { + s.InputConfig = v + return s +} + +// SetJobId sets the JobId field's value. +func (s *DescribePackageImportJobOutput) SetJobId(v string) *DescribePackageImportJobOutput { + s.JobId = &v + return s +} + +// SetJobTags sets the JobTags field's value. +func (s *DescribePackageImportJobOutput) SetJobTags(v []*JobResourceTags) *DescribePackageImportJobOutput { + s.JobTags = v + return s +} + +// SetJobType sets the JobType field's value. +func (s *DescribePackageImportJobOutput) SetJobType(v string) *DescribePackageImportJobOutput { + s.JobType = &v + return s +} + +// SetLastUpdatedTime sets the LastUpdatedTime field's value. +func (s *DescribePackageImportJobOutput) SetLastUpdatedTime(v time.Time) *DescribePackageImportJobOutput { + s.LastUpdatedTime = &v + return s +} + +// SetOutput sets the Output field's value. +func (s *DescribePackageImportJobOutput) SetOutput(v *PackageImportJobOutput_) *DescribePackageImportJobOutput { + s.Output = v + return s +} + +// SetOutputConfig sets the OutputConfig field's value. +func (s *DescribePackageImportJobOutput) SetOutputConfig(v *PackageImportJobOutputConfig) *DescribePackageImportJobOutput { + s.OutputConfig = v + return s +} + +// SetStatus sets the Status field's value. +func (s *DescribePackageImportJobOutput) SetStatus(v string) *DescribePackageImportJobOutput { + s.Status = &v + return s +} + +// SetStatusMessage sets the StatusMessage field's value. +func (s *DescribePackageImportJobOutput) SetStatusMessage(v string) *DescribePackageImportJobOutput { + s.StatusMessage = &v + return s +} + +type DescribePackageInput struct { + _ struct{} `type:"structure" nopayload:"true"` + + // The package's ID. + // + // PackageId is a required field + PackageId *string `location:"uri" locationName:"PackageId" min:"1" type:"string" required:"true"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s DescribePackageInput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s DescribePackageInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *DescribePackageInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "DescribePackageInput"} + if s.PackageId == nil { + invalidParams.Add(request.NewErrParamRequired("PackageId")) + } + if s.PackageId != nil && len(*s.PackageId) < 1 { + invalidParams.Add(request.NewErrParamMinLen("PackageId", 1)) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetPackageId sets the PackageId field's value. +func (s *DescribePackageInput) SetPackageId(v string) *DescribePackageInput { + s.PackageId = &v + return s +} + +type DescribePackageOutput struct { + _ struct{} `type:"structure"` + + // The package's ARN. + // + // Arn is a required field + Arn *string `min:"1" type:"string" required:"true"` + + // When the package was created. + // + // CreatedTime is a required field + CreatedTime *time.Time `type:"timestamp" required:"true"` + + // The package's ID. + // + // PackageId is a required field + PackageId *string `min:"1" type:"string" required:"true"` + + // The package's name. + // + // PackageName is a required field + PackageName *string `min:"1" type:"string" required:"true"` + + // ARNs of accounts that have read access to the package. + ReadAccessPrincipalArns []*string `type:"list"` + + // The package's storage location. + // + // StorageLocation is a required field + StorageLocation *StorageLocation `type:"structure" required:"true"` + + // The package's tags. + // + // Tags is a required field + Tags map[string]*string `type:"map" required:"true"` + + // ARNs of accounts that have write access to the package. + WriteAccessPrincipalArns []*string `type:"list"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s DescribePackageOutput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s DescribePackageOutput) GoString() string { + return s.String() +} + +// SetArn sets the Arn field's value. +func (s *DescribePackageOutput) SetArn(v string) *DescribePackageOutput { + s.Arn = &v + return s +} + +// SetCreatedTime sets the CreatedTime field's value. +func (s *DescribePackageOutput) SetCreatedTime(v time.Time) *DescribePackageOutput { + s.CreatedTime = &v + return s +} + +// SetPackageId sets the PackageId field's value. +func (s *DescribePackageOutput) SetPackageId(v string) *DescribePackageOutput { + s.PackageId = &v + return s +} + +// SetPackageName sets the PackageName field's value. +func (s *DescribePackageOutput) SetPackageName(v string) *DescribePackageOutput { + s.PackageName = &v + return s +} + +// SetReadAccessPrincipalArns sets the ReadAccessPrincipalArns field's value. +func (s *DescribePackageOutput) SetReadAccessPrincipalArns(v []*string) *DescribePackageOutput { + s.ReadAccessPrincipalArns = v + return s +} + +// SetStorageLocation sets the StorageLocation field's value. +func (s *DescribePackageOutput) SetStorageLocation(v *StorageLocation) *DescribePackageOutput { + s.StorageLocation = v + return s +} + +// SetTags sets the Tags field's value. +func (s *DescribePackageOutput) SetTags(v map[string]*string) *DescribePackageOutput { + s.Tags = v + return s +} + +// SetWriteAccessPrincipalArns sets the WriteAccessPrincipalArns field's value. +func (s *DescribePackageOutput) SetWriteAccessPrincipalArns(v []*string) *DescribePackageOutput { + s.WriteAccessPrincipalArns = v + return s +} + +type DescribePackageVersionInput struct { + _ struct{} `type:"structure" nopayload:"true"` + + // The version's owner account. + OwnerAccount *string `location:"querystring" locationName:"OwnerAccount" min:"1" type:"string"` + + // The version's ID. + // + // PackageId is a required field + PackageId *string `location:"uri" locationName:"PackageId" min:"1" type:"string" required:"true"` + + // The version's version. + // + // PackageVersion is a required field + PackageVersion *string `location:"uri" locationName:"PackageVersion" min:"1" type:"string" required:"true"` + + // The version's patch version. + PatchVersion *string `location:"querystring" locationName:"PatchVersion" min:"1" type:"string"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s DescribePackageVersionInput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s DescribePackageVersionInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *DescribePackageVersionInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "DescribePackageVersionInput"} + if s.OwnerAccount != nil && len(*s.OwnerAccount) < 1 { + invalidParams.Add(request.NewErrParamMinLen("OwnerAccount", 1)) + } + if s.PackageId == nil { + invalidParams.Add(request.NewErrParamRequired("PackageId")) + } + if s.PackageId != nil && len(*s.PackageId) < 1 { + invalidParams.Add(request.NewErrParamMinLen("PackageId", 1)) + } + if s.PackageVersion == nil { + invalidParams.Add(request.NewErrParamRequired("PackageVersion")) + } + if s.PackageVersion != nil && len(*s.PackageVersion) < 1 { + invalidParams.Add(request.NewErrParamMinLen("PackageVersion", 1)) + } + if s.PatchVersion != nil && len(*s.PatchVersion) < 1 { + invalidParams.Add(request.NewErrParamMinLen("PatchVersion", 1)) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetOwnerAccount sets the OwnerAccount field's value. +func (s *DescribePackageVersionInput) SetOwnerAccount(v string) *DescribePackageVersionInput { + s.OwnerAccount = &v + return s +} + +// SetPackageId sets the PackageId field's value. +func (s *DescribePackageVersionInput) SetPackageId(v string) *DescribePackageVersionInput { + s.PackageId = &v + return s +} + +// SetPackageVersion sets the PackageVersion field's value. +func (s *DescribePackageVersionInput) SetPackageVersion(v string) *DescribePackageVersionInput { + s.PackageVersion = &v + return s +} + +// SetPatchVersion sets the PatchVersion field's value. +func (s *DescribePackageVersionInput) SetPatchVersion(v string) *DescribePackageVersionInput { + s.PatchVersion = &v + return s +} + +type DescribePackageVersionOutput struct { + _ struct{} `type:"structure"` + + // Whether the version is the latest available. + // + // IsLatestPatch is a required field + IsLatestPatch *bool `type:"boolean" required:"true"` + + // The account ID of the version's owner. + OwnerAccount *string `min:"1" type:"string"` + + // The ARN of the package. + PackageArn *string `min:"1" type:"string"` + + // The version's ID. + // + // PackageId is a required field + PackageId *string `min:"1" type:"string" required:"true"` + + // The version's name. + // + // PackageName is a required field + PackageName *string `min:"1" type:"string" required:"true"` + + // The version's version. + // + // PackageVersion is a required field + PackageVersion *string `min:"1" type:"string" required:"true"` + + // The version's patch version. + // + // PatchVersion is a required field + PatchVersion *string `min:"1" type:"string" required:"true"` + + // The version's registered time. + RegisteredTime *time.Time `type:"timestamp"` + + // The version's status. + // + // Status is a required field + Status *string `type:"string" required:"true" enum:"PackageVersionStatus"` + + // The version's status description. + StatusDescription *string `min:"1" type:"string"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s DescribePackageVersionOutput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s DescribePackageVersionOutput) GoString() string { + return s.String() +} + +// SetIsLatestPatch sets the IsLatestPatch field's value. +func (s *DescribePackageVersionOutput) SetIsLatestPatch(v bool) *DescribePackageVersionOutput { + s.IsLatestPatch = &v + return s +} + +// SetOwnerAccount sets the OwnerAccount field's value. +func (s *DescribePackageVersionOutput) SetOwnerAccount(v string) *DescribePackageVersionOutput { + s.OwnerAccount = &v + return s +} + +// SetPackageArn sets the PackageArn field's value. +func (s *DescribePackageVersionOutput) SetPackageArn(v string) *DescribePackageVersionOutput { + s.PackageArn = &v + return s +} + +// SetPackageId sets the PackageId field's value. +func (s *DescribePackageVersionOutput) SetPackageId(v string) *DescribePackageVersionOutput { + s.PackageId = &v + return s +} + +// SetPackageName sets the PackageName field's value. +func (s *DescribePackageVersionOutput) SetPackageName(v string) *DescribePackageVersionOutput { + s.PackageName = &v + return s +} + +// SetPackageVersion sets the PackageVersion field's value. +func (s *DescribePackageVersionOutput) SetPackageVersion(v string) *DescribePackageVersionOutput { + s.PackageVersion = &v + return s +} + +// SetPatchVersion sets the PatchVersion field's value. +func (s *DescribePackageVersionOutput) SetPatchVersion(v string) *DescribePackageVersionOutput { + s.PatchVersion = &v + return s +} + +// SetRegisteredTime sets the RegisteredTime field's value. +func (s *DescribePackageVersionOutput) SetRegisteredTime(v time.Time) *DescribePackageVersionOutput { + s.RegisteredTime = &v + return s +} + +// SetStatus sets the Status field's value. +func (s *DescribePackageVersionOutput) SetStatus(v string) *DescribePackageVersionOutput { + s.Status = &v + return s +} + +// SetStatusDescription sets the StatusDescription field's value. +func (s *DescribePackageVersionOutput) SetStatusDescription(v string) *DescribePackageVersionOutput { + s.StatusDescription = &v + return s +} + +// A device. +type Device struct { + _ struct{} `type:"structure"` + + // When the device was created. + CreatedTime *time.Time `type:"timestamp"` + + // The device's ID. + DeviceId *string `min:"1" type:"string"` + + // When the device was updated. + LastUpdatedTime *time.Time `type:"timestamp"` + + // The device's lease expiration time. + LeaseExpirationTime *time.Time `type:"timestamp"` + + // The device's name. + Name *string `min:"1" type:"string"` + + // The device's provisioning status. + ProvisioningStatus *string `type:"string" enum:"DeviceStatus"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s Device) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s Device) GoString() string { + return s.String() +} + +// SetCreatedTime sets the CreatedTime field's value. +func (s *Device) SetCreatedTime(v time.Time) *Device { + s.CreatedTime = &v + return s +} + +// SetDeviceId sets the DeviceId field's value. +func (s *Device) SetDeviceId(v string) *Device { + s.DeviceId = &v + return s +} + +// SetLastUpdatedTime sets the LastUpdatedTime field's value. +func (s *Device) SetLastUpdatedTime(v time.Time) *Device { + s.LastUpdatedTime = &v + return s +} + +// SetLeaseExpirationTime sets the LeaseExpirationTime field's value. +func (s *Device) SetLeaseExpirationTime(v time.Time) *Device { + s.LeaseExpirationTime = &v + return s +} + +// SetName sets the Name field's value. +func (s *Device) SetName(v string) *Device { + s.Name = &v + return s +} + +// SetProvisioningStatus sets the ProvisioningStatus field's value. +func (s *Device) SetProvisioningStatus(v string) *Device { + s.ProvisioningStatus = &v + return s +} + +// A job that runs on a device. +type DeviceJob struct { + _ struct{} `type:"structure"` + + // When the job was created. + CreatedTime *time.Time `type:"timestamp"` + + // The ID of the target device. + DeviceId *string `min:"1" type:"string"` + + // The name of the target device + DeviceName *string `min:"1" type:"string"` + + // The job's ID. + JobId *string `min:"1" type:"string"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s DeviceJob) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s DeviceJob) GoString() string { + return s.String() +} + +// SetCreatedTime sets the CreatedTime field's value. +func (s *DeviceJob) SetCreatedTime(v time.Time) *DeviceJob { + s.CreatedTime = &v + return s +} + +// SetDeviceId sets the DeviceId field's value. +func (s *DeviceJob) SetDeviceId(v string) *DeviceJob { + s.DeviceId = &v + return s +} + +// SetDeviceName sets the DeviceName field's value. +func (s *DeviceJob) SetDeviceName(v string) *DeviceJob { + s.DeviceName = &v + return s +} + +// SetJobId sets the JobId field's value. +func (s *DeviceJob) SetJobId(v string) *DeviceJob { + s.JobId = &v + return s +} + +// A job's configuration. +type DeviceJobConfig struct { + _ struct{} `type:"structure"` + + // A configuration for an over-the-air (OTA) upgrade. Required for OTA jobs. + OTAJobConfig *OTAJobConfig `type:"structure"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s DeviceJobConfig) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s DeviceJobConfig) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *DeviceJobConfig) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "DeviceJobConfig"} + if s.OTAJobConfig != nil { + if err := s.OTAJobConfig.Validate(); err != nil { + invalidParams.AddNested("OTAJobConfig", err.(request.ErrInvalidParams)) + } + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetOTAJobConfig sets the OTAJobConfig field's value. +func (s *DeviceJobConfig) SetOTAJobConfig(v *OTAJobConfig) *DeviceJobConfig { + s.OTAJobConfig = v + return s +} + +// A device's network configuration. +type EthernetPayload struct { + _ struct{} `type:"structure"` + + // How the device gets an IP address. + // + // ConnectionType is a required field + ConnectionType *string `type:"string" required:"true" enum:"ConnectionType"` + + // Network configuration for a static IP connection. + StaticIpConnectionInfo *StaticIpConnectionInfo `type:"structure"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s EthernetPayload) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s EthernetPayload) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *EthernetPayload) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "EthernetPayload"} + if s.ConnectionType == nil { + invalidParams.Add(request.NewErrParamRequired("ConnectionType")) + } + if s.StaticIpConnectionInfo != nil { + if err := s.StaticIpConnectionInfo.Validate(); err != nil { + invalidParams.AddNested("StaticIpConnectionInfo", err.(request.ErrInvalidParams)) + } + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetConnectionType sets the ConnectionType field's value. +func (s *EthernetPayload) SetConnectionType(v string) *EthernetPayload { + s.ConnectionType = &v + return s +} + +// SetStaticIpConnectionInfo sets the StaticIpConnectionInfo field's value. +func (s *EthernetPayload) SetStaticIpConnectionInfo(v *StaticIpConnectionInfo) *EthernetPayload { + s.StaticIpConnectionInfo = v + return s +} + +// A device's Ethernet status. +type EthernetStatus struct { + _ struct{} `type:"structure"` + + // The device's connection status. + ConnectionStatus *string `type:"string" enum:"NetworkConnectionStatus"` + + // The device's physical address. + HwAddress *string `min:"1" type:"string"` + + // The device's IP address. + IpAddress *string `min:"1" type:"string"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s EthernetStatus) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s EthernetStatus) GoString() string { + return s.String() +} + +// SetConnectionStatus sets the ConnectionStatus field's value. +func (s *EthernetStatus) SetConnectionStatus(v string) *EthernetStatus { + s.ConnectionStatus = &v + return s +} + +// SetHwAddress sets the HwAddress field's value. +func (s *EthernetStatus) SetHwAddress(v string) *EthernetStatus { + s.HwAddress = &v + return s +} + +// SetIpAddress sets the IpAddress field's value. +func (s *EthernetStatus) SetIpAddress(v string) *EthernetStatus { + s.IpAddress = &v + return s +} + +// An internal error occurred. +type InternalServerException struct { + _ struct{} `type:"structure"` + RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"` + + Message_ *string `locationName:"Message" type:"string"` + + // The number of seconds a client should wait before retrying the call. + RetryAfterSeconds *int64 `location:"header" locationName:"Retry-After" type:"integer"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s InternalServerException) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s InternalServerException) GoString() string { + return s.String() +} + +func newErrorInternalServerException(v protocol.ResponseMetadata) error { + return &InternalServerException{ + RespMetadata: v, + } +} + +// Code returns the exception type name. +func (s *InternalServerException) Code() string { + return "InternalServerException" +} + +// Message returns the exception's message. +func (s *InternalServerException) Message() string { + if s.Message_ != nil { + return *s.Message_ + } + return "" +} + +// OrigErr always returns nil, satisfies awserr.Error interface. +func (s *InternalServerException) OrigErr() error { + return nil +} + +func (s *InternalServerException) Error() string { + return fmt.Sprintf("%s: %s\n%s", s.Code(), s.Message(), s.String()) +} + +// Status code returns the HTTP status code for the request's response error. +func (s *InternalServerException) StatusCode() int { + return s.RespMetadata.StatusCode +} + +// RequestID returns the service's response RequestID for request. +func (s *InternalServerException) RequestID() string { + return s.RespMetadata.RequestID +} + +// A job for a device. +type Job struct { + _ struct{} `type:"structure"` + + // The target device's ID. + DeviceId *string `min:"1" type:"string"` + + // The job's ID. + JobId *string `min:"1" type:"string"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s Job) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s Job) GoString() string { + return s.String() +} + +// SetDeviceId sets the DeviceId field's value. +func (s *Job) SetDeviceId(v string) *Job { + s.DeviceId = &v + return s +} + +// SetJobId sets the JobId field's value. +func (s *Job) SetJobId(v string) *Job { + s.JobId = &v + return s +} + +// Tags for a job. +type JobResourceTags struct { + _ struct{} `type:"structure"` + + // The job's type. + // + // ResourceType is a required field + ResourceType *string `type:"string" required:"true" enum:"JobResourceType"` + + // The job's tags. + // + // Tags is a required field + Tags map[string]*string `type:"map" required:"true"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s JobResourceTags) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s JobResourceTags) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *JobResourceTags) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "JobResourceTags"} + if s.ResourceType == nil { + invalidParams.Add(request.NewErrParamRequired("ResourceType")) + } + if s.Tags == nil { + invalidParams.Add(request.NewErrParamRequired("Tags")) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetResourceType sets the ResourceType field's value. +func (s *JobResourceTags) SetResourceType(v string) *JobResourceTags { + s.ResourceType = &v + return s +} + +// SetTags sets the Tags field's value. +func (s *JobResourceTags) SetTags(v map[string]*string) *JobResourceTags { + s.Tags = v + return s +} + +type ListApplicationInstanceDependenciesInput struct { + _ struct{} `type:"structure" nopayload:"true"` + + // The application instance's ID. + // + // ApplicationInstanceId is a required field + ApplicationInstanceId *string `location:"uri" locationName:"applicationInstanceId" min:"1" type:"string" required:"true"` + + // The maximum number of application instance dependencies to return in one + // page of results. + MaxResults *int64 `location:"querystring" locationName:"maxResults" type:"integer"` + + // Specify the pagination token from a previous request to retrieve the next + // page of results. + NextToken *string `location:"querystring" locationName:"nextToken" min:"1" type:"string"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ListApplicationInstanceDependenciesInput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ListApplicationInstanceDependenciesInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *ListApplicationInstanceDependenciesInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "ListApplicationInstanceDependenciesInput"} + if s.ApplicationInstanceId == nil { + invalidParams.Add(request.NewErrParamRequired("ApplicationInstanceId")) + } + if s.ApplicationInstanceId != nil && len(*s.ApplicationInstanceId) < 1 { + invalidParams.Add(request.NewErrParamMinLen("ApplicationInstanceId", 1)) + } + if s.NextToken != nil && len(*s.NextToken) < 1 { + invalidParams.Add(request.NewErrParamMinLen("NextToken", 1)) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetApplicationInstanceId sets the ApplicationInstanceId field's value. +func (s *ListApplicationInstanceDependenciesInput) SetApplicationInstanceId(v string) *ListApplicationInstanceDependenciesInput { + s.ApplicationInstanceId = &v + return s +} + +// SetMaxResults sets the MaxResults field's value. +func (s *ListApplicationInstanceDependenciesInput) SetMaxResults(v int64) *ListApplicationInstanceDependenciesInput { + s.MaxResults = &v + return s +} + +// SetNextToken sets the NextToken field's value. +func (s *ListApplicationInstanceDependenciesInput) SetNextToken(v string) *ListApplicationInstanceDependenciesInput { + s.NextToken = &v + return s +} + +type ListApplicationInstanceDependenciesOutput struct { + _ struct{} `type:"structure"` + + // A pagination token that's included if more results are available. + NextToken *string `min:"1" type:"string"` + + // A list of package objects. + PackageObjects []*PackageObject `type:"list"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ListApplicationInstanceDependenciesOutput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ListApplicationInstanceDependenciesOutput) GoString() string { + return s.String() +} + +// SetNextToken sets the NextToken field's value. +func (s *ListApplicationInstanceDependenciesOutput) SetNextToken(v string) *ListApplicationInstanceDependenciesOutput { + s.NextToken = &v + return s +} + +// SetPackageObjects sets the PackageObjects field's value. +func (s *ListApplicationInstanceDependenciesOutput) SetPackageObjects(v []*PackageObject) *ListApplicationInstanceDependenciesOutput { + s.PackageObjects = v + return s +} + +type ListApplicationInstanceNodeInstancesInput struct { + _ struct{} `type:"structure" nopayload:"true"` + + // The node instances' application instance ID. + // + // ApplicationInstanceId is a required field + ApplicationInstanceId *string `location:"uri" locationName:"applicationInstanceId" min:"1" type:"string" required:"true"` + + // The maximum number of node instances to return in one page of results. + MaxResults *int64 `location:"querystring" locationName:"maxResults" type:"integer"` + + // Specify the pagination token from a previous request to retrieve the next + // page of results. + NextToken *string `location:"querystring" locationName:"nextToken" min:"1" type:"string"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ListApplicationInstanceNodeInstancesInput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ListApplicationInstanceNodeInstancesInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *ListApplicationInstanceNodeInstancesInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "ListApplicationInstanceNodeInstancesInput"} + if s.ApplicationInstanceId == nil { + invalidParams.Add(request.NewErrParamRequired("ApplicationInstanceId")) + } + if s.ApplicationInstanceId != nil && len(*s.ApplicationInstanceId) < 1 { + invalidParams.Add(request.NewErrParamMinLen("ApplicationInstanceId", 1)) + } + if s.NextToken != nil && len(*s.NextToken) < 1 { + invalidParams.Add(request.NewErrParamMinLen("NextToken", 1)) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetApplicationInstanceId sets the ApplicationInstanceId field's value. +func (s *ListApplicationInstanceNodeInstancesInput) SetApplicationInstanceId(v string) *ListApplicationInstanceNodeInstancesInput { + s.ApplicationInstanceId = &v + return s +} + +// SetMaxResults sets the MaxResults field's value. +func (s *ListApplicationInstanceNodeInstancesInput) SetMaxResults(v int64) *ListApplicationInstanceNodeInstancesInput { + s.MaxResults = &v + return s +} + +// SetNextToken sets the NextToken field's value. +func (s *ListApplicationInstanceNodeInstancesInput) SetNextToken(v string) *ListApplicationInstanceNodeInstancesInput { + s.NextToken = &v + return s +} + +type ListApplicationInstanceNodeInstancesOutput struct { + _ struct{} `type:"structure"` + + // A pagination token that's included if more results are available. + NextToken *string `min:"1" type:"string"` + + // A list of node instances. + NodeInstances []*NodeInstance `type:"list"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ListApplicationInstanceNodeInstancesOutput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ListApplicationInstanceNodeInstancesOutput) GoString() string { + return s.String() +} + +// SetNextToken sets the NextToken field's value. +func (s *ListApplicationInstanceNodeInstancesOutput) SetNextToken(v string) *ListApplicationInstanceNodeInstancesOutput { + s.NextToken = &v + return s +} + +// SetNodeInstances sets the NodeInstances field's value. +func (s *ListApplicationInstanceNodeInstancesOutput) SetNodeInstances(v []*NodeInstance) *ListApplicationInstanceNodeInstancesOutput { + s.NodeInstances = v + return s +} + +type ListApplicationInstancesInput struct { + _ struct{} `type:"structure" nopayload:"true"` + + // The application instances' device ID. + DeviceId *string `location:"querystring" locationName:"deviceId" min:"1" type:"string"` + + // The maximum number of application instances to return in one page of results. + MaxResults *int64 `location:"querystring" locationName:"maxResults" type:"integer"` + + // Specify the pagination token from a previous request to retrieve the next + // page of results. + NextToken *string `location:"querystring" locationName:"nextToken" min:"1" type:"string"` + + // Only include instances with a specific status. + StatusFilter *string `location:"querystring" locationName:"statusFilter" type:"string" enum:"StatusFilter"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ListApplicationInstancesInput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ListApplicationInstancesInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *ListApplicationInstancesInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "ListApplicationInstancesInput"} + if s.DeviceId != nil && len(*s.DeviceId) < 1 { + invalidParams.Add(request.NewErrParamMinLen("DeviceId", 1)) + } + if s.NextToken != nil && len(*s.NextToken) < 1 { + invalidParams.Add(request.NewErrParamMinLen("NextToken", 1)) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetDeviceId sets the DeviceId field's value. +func (s *ListApplicationInstancesInput) SetDeviceId(v string) *ListApplicationInstancesInput { + s.DeviceId = &v + return s +} + +// SetMaxResults sets the MaxResults field's value. +func (s *ListApplicationInstancesInput) SetMaxResults(v int64) *ListApplicationInstancesInput { + s.MaxResults = &v + return s +} + +// SetNextToken sets the NextToken field's value. +func (s *ListApplicationInstancesInput) SetNextToken(v string) *ListApplicationInstancesInput { + s.NextToken = &v + return s +} + +// SetStatusFilter sets the StatusFilter field's value. +func (s *ListApplicationInstancesInput) SetStatusFilter(v string) *ListApplicationInstancesInput { + s.StatusFilter = &v + return s +} + +type ListApplicationInstancesOutput struct { + _ struct{} `type:"structure"` + + // A list of application instances. + ApplicationInstances []*ApplicationInstance `type:"list"` + + // A pagination token that's included if more results are available. + NextToken *string `min:"1" type:"string"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ListApplicationInstancesOutput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ListApplicationInstancesOutput) GoString() string { + return s.String() +} + +// SetApplicationInstances sets the ApplicationInstances field's value. +func (s *ListApplicationInstancesOutput) SetApplicationInstances(v []*ApplicationInstance) *ListApplicationInstancesOutput { + s.ApplicationInstances = v + return s +} + +// SetNextToken sets the NextToken field's value. +func (s *ListApplicationInstancesOutput) SetNextToken(v string) *ListApplicationInstancesOutput { + s.NextToken = &v + return s +} + +type ListDevicesInput struct { + _ struct{} `type:"structure" nopayload:"true"` + + // The maximum number of devices to return in one page of results. + MaxResults *int64 `location:"querystring" locationName:"MaxResults" type:"integer"` + + // Specify the pagination token from a previous request to retrieve the next + // page of results. + NextToken *string `location:"querystring" locationName:"NextToken" min:"1" type:"string"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ListDevicesInput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ListDevicesInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *ListDevicesInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "ListDevicesInput"} + if s.NextToken != nil && len(*s.NextToken) < 1 { + invalidParams.Add(request.NewErrParamMinLen("NextToken", 1)) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetMaxResults sets the MaxResults field's value. +func (s *ListDevicesInput) SetMaxResults(v int64) *ListDevicesInput { + s.MaxResults = &v + return s +} + +// SetNextToken sets the NextToken field's value. +func (s *ListDevicesInput) SetNextToken(v string) *ListDevicesInput { + s.NextToken = &v + return s +} + +type ListDevicesJobsInput struct { + _ struct{} `type:"structure" nopayload:"true"` + + // Filter results by the job's target device ID. + DeviceId *string `location:"querystring" locationName:"DeviceId" min:"1" type:"string"` + + // The maximum number of device jobs to return in one page of results. + MaxResults *int64 `location:"querystring" locationName:"MaxResults" type:"integer"` + + // Specify the pagination token from a previous request to retrieve the next + // page of results. + NextToken *string `location:"querystring" locationName:"NextToken" min:"1" type:"string"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ListDevicesJobsInput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ListDevicesJobsInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *ListDevicesJobsInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "ListDevicesJobsInput"} + if s.DeviceId != nil && len(*s.DeviceId) < 1 { + invalidParams.Add(request.NewErrParamMinLen("DeviceId", 1)) + } + if s.NextToken != nil && len(*s.NextToken) < 1 { + invalidParams.Add(request.NewErrParamMinLen("NextToken", 1)) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetDeviceId sets the DeviceId field's value. +func (s *ListDevicesJobsInput) SetDeviceId(v string) *ListDevicesJobsInput { + s.DeviceId = &v + return s +} + +// SetMaxResults sets the MaxResults field's value. +func (s *ListDevicesJobsInput) SetMaxResults(v int64) *ListDevicesJobsInput { + s.MaxResults = &v + return s +} + +// SetNextToken sets the NextToken field's value. +func (s *ListDevicesJobsInput) SetNextToken(v string) *ListDevicesJobsInput { + s.NextToken = &v + return s +} + +type ListDevicesJobsOutput struct { + _ struct{} `type:"structure"` + + // A list of jobs. + DeviceJobs []*DeviceJob `type:"list"` + + // A pagination token that's included if more results are available. + NextToken *string `min:"1" type:"string"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ListDevicesJobsOutput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ListDevicesJobsOutput) GoString() string { + return s.String() +} + +// SetDeviceJobs sets the DeviceJobs field's value. +func (s *ListDevicesJobsOutput) SetDeviceJobs(v []*DeviceJob) *ListDevicesJobsOutput { + s.DeviceJobs = v + return s +} + +// SetNextToken sets the NextToken field's value. +func (s *ListDevicesJobsOutput) SetNextToken(v string) *ListDevicesJobsOutput { + s.NextToken = &v + return s +} + +type ListDevicesOutput struct { + _ struct{} `type:"structure"` + + // A list of devices. + // + // Devices is a required field + Devices []*Device `type:"list" required:"true"` + + // A pagination token that's included if more results are available. + NextToken *string `min:"1" type:"string"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ListDevicesOutput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ListDevicesOutput) GoString() string { + return s.String() +} + +// SetDevices sets the Devices field's value. +func (s *ListDevicesOutput) SetDevices(v []*Device) *ListDevicesOutput { + s.Devices = v + return s +} + +// SetNextToken sets the NextToken field's value. +func (s *ListDevicesOutput) SetNextToken(v string) *ListDevicesOutput { + s.NextToken = &v + return s +} + +type ListNodeFromTemplateJobsInput struct { + _ struct{} `type:"structure" nopayload:"true"` + + // The maximum number of node from template jobs to return in one page of results. + MaxResults *int64 `location:"querystring" locationName:"MaxResults" type:"integer"` + + // Specify the pagination token from a previous request to retrieve the next + // page of results. + NextToken *string `location:"querystring" locationName:"NextToken" min:"1" type:"string"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ListNodeFromTemplateJobsInput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ListNodeFromTemplateJobsInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *ListNodeFromTemplateJobsInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "ListNodeFromTemplateJobsInput"} + if s.NextToken != nil && len(*s.NextToken) < 1 { + invalidParams.Add(request.NewErrParamMinLen("NextToken", 1)) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetMaxResults sets the MaxResults field's value. +func (s *ListNodeFromTemplateJobsInput) SetMaxResults(v int64) *ListNodeFromTemplateJobsInput { + s.MaxResults = &v + return s +} + +// SetNextToken sets the NextToken field's value. +func (s *ListNodeFromTemplateJobsInput) SetNextToken(v string) *ListNodeFromTemplateJobsInput { + s.NextToken = &v + return s +} + +type ListNodeFromTemplateJobsOutput struct { + _ struct{} `type:"structure"` + + // A pagination token that's included if more results are available. + NextToken *string `min:"1" type:"string"` + + // A list of jobs. + // + // NodeFromTemplateJobs is a required field + NodeFromTemplateJobs []*NodeFromTemplateJob `type:"list" required:"true"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ListNodeFromTemplateJobsOutput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ListNodeFromTemplateJobsOutput) GoString() string { + return s.String() +} + +// SetNextToken sets the NextToken field's value. +func (s *ListNodeFromTemplateJobsOutput) SetNextToken(v string) *ListNodeFromTemplateJobsOutput { + s.NextToken = &v + return s +} + +// SetNodeFromTemplateJobs sets the NodeFromTemplateJobs field's value. +func (s *ListNodeFromTemplateJobsOutput) SetNodeFromTemplateJobs(v []*NodeFromTemplateJob) *ListNodeFromTemplateJobsOutput { + s.NodeFromTemplateJobs = v + return s +} + +type ListNodesInput struct { + _ struct{} `type:"structure" nopayload:"true"` + + // Search for nodes by category. + Category *string `location:"querystring" locationName:"category" type:"string" enum:"NodeCategory"` + + // The maximum number of nodes to return in one page of results. + MaxResults *int64 `location:"querystring" locationName:"maxResults" type:"integer"` + + // Specify the pagination token from a previous request to retrieve the next + // page of results. + NextToken *string `location:"querystring" locationName:"nextToken" min:"1" type:"string"` + + // Search for nodes by the account ID of the nodes' owner. + OwnerAccount *string `location:"querystring" locationName:"ownerAccount" min:"1" type:"string"` + + // Search for nodes by name. + PackageName *string `location:"querystring" locationName:"packageName" min:"1" type:"string"` + + // Search for nodes by version. + PackageVersion *string `location:"querystring" locationName:"packageVersion" min:"1" type:"string"` + + // Search for nodes by patch version. + PatchVersion *string `location:"querystring" locationName:"patchVersion" min:"1" type:"string"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ListNodesInput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ListNodesInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *ListNodesInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "ListNodesInput"} + if s.NextToken != nil && len(*s.NextToken) < 1 { + invalidParams.Add(request.NewErrParamMinLen("NextToken", 1)) + } + if s.OwnerAccount != nil && len(*s.OwnerAccount) < 1 { + invalidParams.Add(request.NewErrParamMinLen("OwnerAccount", 1)) + } + if s.PackageName != nil && len(*s.PackageName) < 1 { + invalidParams.Add(request.NewErrParamMinLen("PackageName", 1)) + } + if s.PackageVersion != nil && len(*s.PackageVersion) < 1 { + invalidParams.Add(request.NewErrParamMinLen("PackageVersion", 1)) + } + if s.PatchVersion != nil && len(*s.PatchVersion) < 1 { + invalidParams.Add(request.NewErrParamMinLen("PatchVersion", 1)) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetCategory sets the Category field's value. +func (s *ListNodesInput) SetCategory(v string) *ListNodesInput { + s.Category = &v + return s +} + +// SetMaxResults sets the MaxResults field's value. +func (s *ListNodesInput) SetMaxResults(v int64) *ListNodesInput { + s.MaxResults = &v + return s +} + +// SetNextToken sets the NextToken field's value. +func (s *ListNodesInput) SetNextToken(v string) *ListNodesInput { + s.NextToken = &v + return s +} + +// SetOwnerAccount sets the OwnerAccount field's value. +func (s *ListNodesInput) SetOwnerAccount(v string) *ListNodesInput { + s.OwnerAccount = &v + return s +} + +// SetPackageName sets the PackageName field's value. +func (s *ListNodesInput) SetPackageName(v string) *ListNodesInput { + s.PackageName = &v + return s +} + +// SetPackageVersion sets the PackageVersion field's value. +func (s *ListNodesInput) SetPackageVersion(v string) *ListNodesInput { + s.PackageVersion = &v + return s +} + +// SetPatchVersion sets the PatchVersion field's value. +func (s *ListNodesInput) SetPatchVersion(v string) *ListNodesInput { + s.PatchVersion = &v + return s +} + +type ListNodesOutput struct { + _ struct{} `type:"structure"` + + // A pagination token that's included if more results are available. + NextToken *string `min:"1" type:"string"` + + // A list of nodes. + Nodes []*Node `type:"list"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ListNodesOutput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ListNodesOutput) GoString() string { + return s.String() +} + +// SetNextToken sets the NextToken field's value. +func (s *ListNodesOutput) SetNextToken(v string) *ListNodesOutput { + s.NextToken = &v + return s +} + +// SetNodes sets the Nodes field's value. +func (s *ListNodesOutput) SetNodes(v []*Node) *ListNodesOutput { + s.Nodes = v + return s +} + +type ListPackageImportJobsInput struct { + _ struct{} `type:"structure" nopayload:"true"` + + // The maximum number of package import jobs to return in one page of results. + MaxResults *int64 `location:"querystring" locationName:"MaxResults" type:"integer"` + + // Specify the pagination token from a previous request to retrieve the next + // page of results. + NextToken *string `location:"querystring" locationName:"NextToken" min:"1" type:"string"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ListPackageImportJobsInput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ListPackageImportJobsInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *ListPackageImportJobsInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "ListPackageImportJobsInput"} + if s.NextToken != nil && len(*s.NextToken) < 1 { + invalidParams.Add(request.NewErrParamMinLen("NextToken", 1)) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetMaxResults sets the MaxResults field's value. +func (s *ListPackageImportJobsInput) SetMaxResults(v int64) *ListPackageImportJobsInput { + s.MaxResults = &v + return s +} + +// SetNextToken sets the NextToken field's value. +func (s *ListPackageImportJobsInput) SetNextToken(v string) *ListPackageImportJobsInput { + s.NextToken = &v + return s +} + +type ListPackageImportJobsOutput struct { + _ struct{} `type:"structure"` + + // A pagination token that's included if more results are available. + NextToken *string `min:"1" type:"string"` + + // A list of package import jobs. + // + // PackageImportJobs is a required field + PackageImportJobs []*PackageImportJob `type:"list" required:"true"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ListPackageImportJobsOutput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ListPackageImportJobsOutput) GoString() string { + return s.String() +} + +// SetNextToken sets the NextToken field's value. +func (s *ListPackageImportJobsOutput) SetNextToken(v string) *ListPackageImportJobsOutput { + s.NextToken = &v + return s +} + +// SetPackageImportJobs sets the PackageImportJobs field's value. +func (s *ListPackageImportJobsOutput) SetPackageImportJobs(v []*PackageImportJob) *ListPackageImportJobsOutput { + s.PackageImportJobs = v + return s +} + +type ListPackagesInput struct { + _ struct{} `type:"structure" nopayload:"true"` + + // The maximum number of packages to return in one page of results. + MaxResults *int64 `location:"querystring" locationName:"maxResults" type:"integer"` + + // Specify the pagination token from a previous request to retrieve the next + // page of results. + NextToken *string `location:"querystring" locationName:"nextToken" min:"1" type:"string"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ListPackagesInput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ListPackagesInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *ListPackagesInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "ListPackagesInput"} + if s.NextToken != nil && len(*s.NextToken) < 1 { + invalidParams.Add(request.NewErrParamMinLen("NextToken", 1)) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetMaxResults sets the MaxResults field's value. +func (s *ListPackagesInput) SetMaxResults(v int64) *ListPackagesInput { + s.MaxResults = &v + return s +} + +// SetNextToken sets the NextToken field's value. +func (s *ListPackagesInput) SetNextToken(v string) *ListPackagesInput { + s.NextToken = &v + return s +} + +type ListPackagesOutput struct { + _ struct{} `type:"structure"` + + // A pagination token that's included if more results are available. + NextToken *string `min:"1" type:"string"` + + // A list of packages. + Packages []*PackageListItem `type:"list"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ListPackagesOutput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ListPackagesOutput) GoString() string { + return s.String() +} + +// SetNextToken sets the NextToken field's value. +func (s *ListPackagesOutput) SetNextToken(v string) *ListPackagesOutput { + s.NextToken = &v + return s +} + +// SetPackages sets the Packages field's value. +func (s *ListPackagesOutput) SetPackages(v []*PackageListItem) *ListPackagesOutput { + s.Packages = v + return s +} + +type ListTagsForResourceInput struct { + _ struct{} `type:"structure" nopayload:"true"` + + // The resource's ARN. + // + // ResourceArn is a required field + ResourceArn *string `location:"uri" locationName:"ResourceArn" min:"1" type:"string" required:"true"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ListTagsForResourceInput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ListTagsForResourceInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *ListTagsForResourceInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "ListTagsForResourceInput"} + if s.ResourceArn == nil { + invalidParams.Add(request.NewErrParamRequired("ResourceArn")) + } + if s.ResourceArn != nil && len(*s.ResourceArn) < 1 { + invalidParams.Add(request.NewErrParamMinLen("ResourceArn", 1)) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetResourceArn sets the ResourceArn field's value. +func (s *ListTagsForResourceInput) SetResourceArn(v string) *ListTagsForResourceInput { + s.ResourceArn = &v + return s +} + +type ListTagsForResourceOutput struct { + _ struct{} `type:"structure"` + + // A list of tags. + Tags map[string]*string `type:"map"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ListTagsForResourceOutput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ListTagsForResourceOutput) GoString() string { + return s.String() +} + +// SetTags sets the Tags field's value. +func (s *ListTagsForResourceOutput) SetTags(v map[string]*string) *ListTagsForResourceOutput { + s.Tags = v + return s +} + +// Parameter overrides for an application instance. This is a JSON document +// that has a single key (PayloadData) where the value is an escaped string +// representation of the overrides document. +type ManifestOverridesPayload struct { + _ struct{} `type:"structure"` + + // The overrides document. + PayloadData *string `type:"string"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ManifestOverridesPayload) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ManifestOverridesPayload) GoString() string { + return s.String() +} + +// SetPayloadData sets the PayloadData field's value. +func (s *ManifestOverridesPayload) SetPayloadData(v string) *ManifestOverridesPayload { + s.PayloadData = &v + return s +} + +// A application verion's manifest file. This is a JSON document that has a +// single key (PayloadData) where the value is an escaped string representation +// of the application manifest (graph.json). This file is located in the graphs +// folder in your application source. +type ManifestPayload struct { + _ struct{} `type:"structure"` + + // The application manifest. + PayloadData *string `min:"1" type:"string"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ManifestPayload) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ManifestPayload) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *ManifestPayload) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "ManifestPayload"} + if s.PayloadData != nil && len(*s.PayloadData) < 1 { + invalidParams.Add(request.NewErrParamMinLen("PayloadData", 1)) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetPayloadData sets the PayloadData field's value. +func (s *ManifestPayload) SetPayloadData(v string) *ManifestPayload { + s.PayloadData = &v + return s +} + +// The network configuration for a device. +type NetworkPayload struct { + _ struct{} `type:"structure"` + + // Settings for Ethernet port 0. + Ethernet0 *EthernetPayload `type:"structure"` + + // Settings for Ethernet port 1. + Ethernet1 *EthernetPayload `type:"structure"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s NetworkPayload) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s NetworkPayload) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *NetworkPayload) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "NetworkPayload"} + if s.Ethernet0 != nil { + if err := s.Ethernet0.Validate(); err != nil { + invalidParams.AddNested("Ethernet0", err.(request.ErrInvalidParams)) + } + } + if s.Ethernet1 != nil { + if err := s.Ethernet1.Validate(); err != nil { + invalidParams.AddNested("Ethernet1", err.(request.ErrInvalidParams)) + } + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetEthernet0 sets the Ethernet0 field's value. +func (s *NetworkPayload) SetEthernet0(v *EthernetPayload) *NetworkPayload { + s.Ethernet0 = v + return s +} + +// SetEthernet1 sets the Ethernet1 field's value. +func (s *NetworkPayload) SetEthernet1(v *EthernetPayload) *NetworkPayload { + s.Ethernet1 = v + return s +} + +// The network status of a device. +type NetworkStatus struct { + _ struct{} `type:"structure"` + + // The status of Ethernet port 0. + Ethernet0Status *EthernetStatus `type:"structure"` + + // The status of Ethernet port 1. + Ethernet1Status *EthernetStatus `type:"structure"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s NetworkStatus) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s NetworkStatus) GoString() string { + return s.String() +} + +// SetEthernet0Status sets the Ethernet0Status field's value. +func (s *NetworkStatus) SetEthernet0Status(v *EthernetStatus) *NetworkStatus { + s.Ethernet0Status = v + return s +} + +// SetEthernet1Status sets the Ethernet1Status field's value. +func (s *NetworkStatus) SetEthernet1Status(v *EthernetStatus) *NetworkStatus { + s.Ethernet1Status = v + return s +} + +// An application node that represents a camera stream, a model, code, or output. +type Node struct { + _ struct{} `type:"structure"` + + // The node's category. + // + // Category is a required field + Category *string `type:"string" required:"true" enum:"NodeCategory"` + + // When the node was created. + // + // CreatedTime is a required field + CreatedTime *time.Time `type:"timestamp" required:"true"` + + // The node's description. + Description *string `type:"string"` + + // The node's name. + // + // Name is a required field + Name *string `min:"1" type:"string" required:"true"` + + // The node's ID. + // + // NodeId is a required field + NodeId *string `min:"1" type:"string" required:"true"` + + // The account ID of the node's owner. + OwnerAccount *string `min:"1" type:"string"` + + // The node's ARN. + PackageArn *string `min:"1" type:"string"` + + // The node's package ID. + // + // PackageId is a required field + PackageId *string `min:"1" type:"string" required:"true"` + + // The node's package name. + // + // PackageName is a required field + PackageName *string `min:"1" type:"string" required:"true"` + + // The node's package version. + // + // PackageVersion is a required field + PackageVersion *string `min:"1" type:"string" required:"true"` + + // The node's patch version. + // + // PatchVersion is a required field + PatchVersion *string `min:"1" type:"string" required:"true"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s Node) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s Node) GoString() string { + return s.String() +} + +// SetCategory sets the Category field's value. +func (s *Node) SetCategory(v string) *Node { + s.Category = &v + return s +} + +// SetCreatedTime sets the CreatedTime field's value. +func (s *Node) SetCreatedTime(v time.Time) *Node { + s.CreatedTime = &v + return s +} + +// SetDescription sets the Description field's value. +func (s *Node) SetDescription(v string) *Node { + s.Description = &v + return s +} + +// SetName sets the Name field's value. +func (s *Node) SetName(v string) *Node { + s.Name = &v + return s +} + +// SetNodeId sets the NodeId field's value. +func (s *Node) SetNodeId(v string) *Node { + s.NodeId = &v + return s +} + +// SetOwnerAccount sets the OwnerAccount field's value. +func (s *Node) SetOwnerAccount(v string) *Node { + s.OwnerAccount = &v + return s +} + +// SetPackageArn sets the PackageArn field's value. +func (s *Node) SetPackageArn(v string) *Node { + s.PackageArn = &v + return s +} + +// SetPackageId sets the PackageId field's value. +func (s *Node) SetPackageId(v string) *Node { + s.PackageId = &v + return s +} + +// SetPackageName sets the PackageName field's value. +func (s *Node) SetPackageName(v string) *Node { + s.PackageName = &v + return s +} + +// SetPackageVersion sets the PackageVersion field's value. +func (s *Node) SetPackageVersion(v string) *Node { + s.PackageVersion = &v + return s +} + +// SetPatchVersion sets the PatchVersion field's value. +func (s *Node) SetPatchVersion(v string) *Node { + s.PatchVersion = &v + return s +} + +// A job to create a camera stream node. +type NodeFromTemplateJob struct { + _ struct{} `type:"structure"` + + // When the job was created. + CreatedTime *time.Time `type:"timestamp"` + + // The job's ID. + JobId *string `min:"1" type:"string"` + + // The node's name. + NodeName *string `min:"1" type:"string"` + + // The job's status. + Status *string `type:"string" enum:"NodeFromTemplateJobStatus"` + + // The job's status message. + StatusMessage *string `type:"string"` + + // The job's template type. + TemplateType *string `type:"string" enum:"TemplateType"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s NodeFromTemplateJob) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s NodeFromTemplateJob) GoString() string { + return s.String() +} + +// SetCreatedTime sets the CreatedTime field's value. +func (s *NodeFromTemplateJob) SetCreatedTime(v time.Time) *NodeFromTemplateJob { + s.CreatedTime = &v + return s +} + +// SetJobId sets the JobId field's value. +func (s *NodeFromTemplateJob) SetJobId(v string) *NodeFromTemplateJob { + s.JobId = &v + return s +} + +// SetNodeName sets the NodeName field's value. +func (s *NodeFromTemplateJob) SetNodeName(v string) *NodeFromTemplateJob { + s.NodeName = &v + return s +} + +// SetStatus sets the Status field's value. +func (s *NodeFromTemplateJob) SetStatus(v string) *NodeFromTemplateJob { + s.Status = &v + return s +} + +// SetStatusMessage sets the StatusMessage field's value. +func (s *NodeFromTemplateJob) SetStatusMessage(v string) *NodeFromTemplateJob { + s.StatusMessage = &v + return s +} + +// SetTemplateType sets the TemplateType field's value. +func (s *NodeFromTemplateJob) SetTemplateType(v string) *NodeFromTemplateJob { + s.TemplateType = &v + return s +} + +// A node input port. +type NodeInputPort struct { + _ struct{} `type:"structure"` + + // The input port's default value. + DefaultValue *string `min:"1" type:"string"` + + // The input port's description. + Description *string `type:"string"` + + // The input port's max connections. + MaxConnections *int64 `type:"integer"` + + // The input port's name. + Name *string `min:"1" type:"string"` + + // The input port's type. + Type *string `type:"string" enum:"PortType"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s NodeInputPort) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s NodeInputPort) GoString() string { + return s.String() +} + +// SetDefaultValue sets the DefaultValue field's value. +func (s *NodeInputPort) SetDefaultValue(v string) *NodeInputPort { + s.DefaultValue = &v + return s +} + +// SetDescription sets the Description field's value. +func (s *NodeInputPort) SetDescription(v string) *NodeInputPort { + s.Description = &v + return s +} + +// SetMaxConnections sets the MaxConnections field's value. +func (s *NodeInputPort) SetMaxConnections(v int64) *NodeInputPort { + s.MaxConnections = &v + return s +} + +// SetName sets the Name field's value. +func (s *NodeInputPort) SetName(v string) *NodeInputPort { + s.Name = &v + return s +} + +// SetType sets the Type field's value. +func (s *NodeInputPort) SetType(v string) *NodeInputPort { + s.Type = &v + return s +} + +// A node instance. +type NodeInstance struct { + _ struct{} `type:"structure"` + + // The instance's current status. + // + // CurrentStatus is a required field + CurrentStatus *string `type:"string" required:"true" enum:"NodeInstanceStatus"` + + // The node's ID. + NodeId *string `min:"1" type:"string"` + + // The instance's ID. + // + // NodeInstanceId is a required field + NodeInstanceId *string `min:"1" type:"string" required:"true"` + + // The instance's name. + NodeName *string `min:"1" type:"string"` + + // The instance's package name. + PackageName *string `min:"1" type:"string"` + + // The instance's package patch version. + PackagePatchVersion *string `min:"1" type:"string"` + + // The instance's package version. + PackageVersion *string `min:"1" type:"string"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s NodeInstance) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s NodeInstance) GoString() string { + return s.String() +} + +// SetCurrentStatus sets the CurrentStatus field's value. +func (s *NodeInstance) SetCurrentStatus(v string) *NodeInstance { + s.CurrentStatus = &v + return s +} + +// SetNodeId sets the NodeId field's value. +func (s *NodeInstance) SetNodeId(v string) *NodeInstance { + s.NodeId = &v + return s +} + +// SetNodeInstanceId sets the NodeInstanceId field's value. +func (s *NodeInstance) SetNodeInstanceId(v string) *NodeInstance { + s.NodeInstanceId = &v + return s +} + +// SetNodeName sets the NodeName field's value. +func (s *NodeInstance) SetNodeName(v string) *NodeInstance { + s.NodeName = &v + return s +} + +// SetPackageName sets the PackageName field's value. +func (s *NodeInstance) SetPackageName(v string) *NodeInstance { + s.PackageName = &v + return s +} + +// SetPackagePatchVersion sets the PackagePatchVersion field's value. +func (s *NodeInstance) SetPackagePatchVersion(v string) *NodeInstance { + s.PackagePatchVersion = &v + return s +} + +// SetPackageVersion sets the PackageVersion field's value. +func (s *NodeInstance) SetPackageVersion(v string) *NodeInstance { + s.PackageVersion = &v + return s +} + +// A node interface. +type NodeInterface struct { + _ struct{} `type:"structure"` + + // The node interface's inputs. + // + // Inputs is a required field + Inputs []*NodeInputPort `type:"list" required:"true"` + + // The node interface's outputs. + // + // Outputs is a required field + Outputs []*NodeOutputPort `type:"list" required:"true"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s NodeInterface) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s NodeInterface) GoString() string { + return s.String() +} + +// SetInputs sets the Inputs field's value. +func (s *NodeInterface) SetInputs(v []*NodeInputPort) *NodeInterface { + s.Inputs = v + return s +} + +// SetOutputs sets the Outputs field's value. +func (s *NodeInterface) SetOutputs(v []*NodeOutputPort) *NodeInterface { + s.Outputs = v + return s +} + +// A node output port. +type NodeOutputPort struct { + _ struct{} `type:"structure"` + + // The output port's description. + Description *string `type:"string"` + + // The output port's name. + Name *string `min:"1" type:"string"` + + // The output port's type. + Type *string `type:"string" enum:"PortType"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s NodeOutputPort) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s NodeOutputPort) GoString() string { + return s.String() +} + +// SetDescription sets the Description field's value. +func (s *NodeOutputPort) SetDescription(v string) *NodeOutputPort { + s.Description = &v + return s +} + +// SetName sets the Name field's value. +func (s *NodeOutputPort) SetName(v string) *NodeOutputPort { + s.Name = &v + return s +} + +// SetType sets the Type field's value. +func (s *NodeOutputPort) SetType(v string) *NodeOutputPort { + s.Type = &v + return s +} + +// An over-the-air update (OTA) job configuration. +type OTAJobConfig struct { + _ struct{} `type:"structure"` + + // The target version of the device software. + // + // ImageVersion is a required field + ImageVersion *string `min:"1" type:"string" required:"true"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s OTAJobConfig) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s OTAJobConfig) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *OTAJobConfig) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "OTAJobConfig"} + if s.ImageVersion == nil { + invalidParams.Add(request.NewErrParamRequired("ImageVersion")) + } + if s.ImageVersion != nil && len(*s.ImageVersion) < 1 { + invalidParams.Add(request.NewErrParamMinLen("ImageVersion", 1)) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetImageVersion sets the ImageVersion field's value. +func (s *OTAJobConfig) SetImageVersion(v string) *OTAJobConfig { + s.ImageVersion = &v + return s +} + +// The location of an output object in Amazon S3. +type OutPutS3Location struct { + _ struct{} `type:"structure"` + + // The object's bucket. + // + // BucketName is a required field + BucketName *string `min:"1" type:"string" required:"true"` + + // The object's key. + // + // ObjectKey is a required field + ObjectKey *string `min:"1" type:"string" required:"true"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s OutPutS3Location) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s OutPutS3Location) GoString() string { + return s.String() +} + +// SetBucketName sets the BucketName field's value. +func (s *OutPutS3Location) SetBucketName(v string) *OutPutS3Location { + s.BucketName = &v + return s +} + +// SetObjectKey sets the ObjectKey field's value. +func (s *OutPutS3Location) SetObjectKey(v string) *OutPutS3Location { + s.ObjectKey = &v + return s +} + +// A job to import a package version. +type PackageImportJob struct { + _ struct{} `type:"structure"` + + // When the job was created. + CreatedTime *time.Time `type:"timestamp"` + + // The job's ID. + JobId *string `min:"1" type:"string"` + + // The job's type. + JobType *string `type:"string" enum:"PackageImportJobType"` + + // When the job was updated. + LastUpdatedTime *time.Time `type:"timestamp"` + + // The job's status. + Status *string `type:"string" enum:"PackageImportJobStatus"` + + // The job's status message. + StatusMessage *string `type:"string"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s PackageImportJob) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s PackageImportJob) GoString() string { + return s.String() +} + +// SetCreatedTime sets the CreatedTime field's value. +func (s *PackageImportJob) SetCreatedTime(v time.Time) *PackageImportJob { + s.CreatedTime = &v + return s +} + +// SetJobId sets the JobId field's value. +func (s *PackageImportJob) SetJobId(v string) *PackageImportJob { + s.JobId = &v + return s +} + +// SetJobType sets the JobType field's value. +func (s *PackageImportJob) SetJobType(v string) *PackageImportJob { + s.JobType = &v + return s +} + +// SetLastUpdatedTime sets the LastUpdatedTime field's value. +func (s *PackageImportJob) SetLastUpdatedTime(v time.Time) *PackageImportJob { + s.LastUpdatedTime = &v + return s +} + +// SetStatus sets the Status field's value. +func (s *PackageImportJob) SetStatus(v string) *PackageImportJob { + s.Status = &v + return s +} + +// SetStatusMessage sets the StatusMessage field's value. +func (s *PackageImportJob) SetStatusMessage(v string) *PackageImportJob { + s.StatusMessage = &v + return s +} + +// A configuration for a package import job. +type PackageImportJobInputConfig struct { + _ struct{} `type:"structure"` + + // The package version's input configuration. + PackageVersionInputConfig *PackageVersionInputConfig `type:"structure"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s PackageImportJobInputConfig) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s PackageImportJobInputConfig) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *PackageImportJobInputConfig) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "PackageImportJobInputConfig"} + if s.PackageVersionInputConfig != nil { + if err := s.PackageVersionInputConfig.Validate(); err != nil { + invalidParams.AddNested("PackageVersionInputConfig", err.(request.ErrInvalidParams)) + } + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetPackageVersionInputConfig sets the PackageVersionInputConfig field's value. +func (s *PackageImportJobInputConfig) SetPackageVersionInputConfig(v *PackageVersionInputConfig) *PackageImportJobInputConfig { + s.PackageVersionInputConfig = v + return s +} + +// An output configuration for a package import job. +type PackageImportJobOutputConfig struct { + _ struct{} `type:"structure"` + + // The package version's output configuration. + PackageVersionOutputConfig *PackageVersionOutputConfig `type:"structure"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s PackageImportJobOutputConfig) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s PackageImportJobOutputConfig) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *PackageImportJobOutputConfig) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "PackageImportJobOutputConfig"} + if s.PackageVersionOutputConfig != nil { + if err := s.PackageVersionOutputConfig.Validate(); err != nil { + invalidParams.AddNested("PackageVersionOutputConfig", err.(request.ErrInvalidParams)) + } + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetPackageVersionOutputConfig sets the PackageVersionOutputConfig field's value. +func (s *PackageImportJobOutputConfig) SetPackageVersionOutputConfig(v *PackageVersionOutputConfig) *PackageImportJobOutputConfig { + s.PackageVersionOutputConfig = v + return s +} + +// Results of a package import job. +type PackageImportJobOutput_ struct { + _ struct{} `type:"structure"` + + // The package's output location. + // + // OutputS3Location is a required field + OutputS3Location *OutPutS3Location `type:"structure" required:"true"` + + // The package's ID. + // + // PackageId is a required field + PackageId *string `min:"1" type:"string" required:"true"` + + // The package's version. + // + // PackageVersion is a required field + PackageVersion *string `min:"1" type:"string" required:"true"` + + // The package's patch version. + // + // PatchVersion is a required field + PatchVersion *string `min:"1" type:"string" required:"true"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s PackageImportJobOutput_) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s PackageImportJobOutput_) GoString() string { + return s.String() +} + +// SetOutputS3Location sets the OutputS3Location field's value. +func (s *PackageImportJobOutput_) SetOutputS3Location(v *OutPutS3Location) *PackageImportJobOutput_ { + s.OutputS3Location = v + return s +} + +// SetPackageId sets the PackageId field's value. +func (s *PackageImportJobOutput_) SetPackageId(v string) *PackageImportJobOutput_ { + s.PackageId = &v + return s +} + +// SetPackageVersion sets the PackageVersion field's value. +func (s *PackageImportJobOutput_) SetPackageVersion(v string) *PackageImportJobOutput_ { + s.PackageVersion = &v + return s +} + +// SetPatchVersion sets the PatchVersion field's value. +func (s *PackageImportJobOutput_) SetPatchVersion(v string) *PackageImportJobOutput_ { + s.PatchVersion = &v + return s +} + +// A package summary. +type PackageListItem struct { + _ struct{} `type:"structure"` + + // The package's ARN. + Arn *string `min:"1" type:"string"` + + // When the package was created. + CreatedTime *time.Time `type:"timestamp"` + + // The package's ID. + PackageId *string `min:"1" type:"string"` + + // The package's name. + PackageName *string `min:"1" type:"string"` + + // The package's tags. + Tags map[string]*string `type:"map"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s PackageListItem) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s PackageListItem) GoString() string { + return s.String() +} + +// SetArn sets the Arn field's value. +func (s *PackageListItem) SetArn(v string) *PackageListItem { + s.Arn = &v + return s +} + +// SetCreatedTime sets the CreatedTime field's value. +func (s *PackageListItem) SetCreatedTime(v time.Time) *PackageListItem { + s.CreatedTime = &v + return s +} + +// SetPackageId sets the PackageId field's value. +func (s *PackageListItem) SetPackageId(v string) *PackageListItem { + s.PackageId = &v + return s +} + +// SetPackageName sets the PackageName field's value. +func (s *PackageListItem) SetPackageName(v string) *PackageListItem { + s.PackageName = &v + return s +} + +// SetTags sets the Tags field's value. +func (s *PackageListItem) SetTags(v map[string]*string) *PackageListItem { + s.Tags = v + return s +} + +// A package object. +type PackageObject struct { + _ struct{} `type:"structure"` + + // The object's name. + // + // Name is a required field + Name *string `min:"1" type:"string" required:"true"` + + // The object's package version. + // + // PackageVersion is a required field + PackageVersion *string `min:"1" type:"string" required:"true"` + + // The object's patch version. + // + // PatchVersion is a required field + PatchVersion *string `min:"1" type:"string" required:"true"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s PackageObject) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s PackageObject) GoString() string { + return s.String() +} + +// SetName sets the Name field's value. +func (s *PackageObject) SetName(v string) *PackageObject { + s.Name = &v + return s +} + +// SetPackageVersion sets the PackageVersion field's value. +func (s *PackageObject) SetPackageVersion(v string) *PackageObject { + s.PackageVersion = &v + return s +} + +// SetPatchVersion sets the PatchVersion field's value. +func (s *PackageObject) SetPatchVersion(v string) *PackageObject { + s.PatchVersion = &v + return s +} + +// A package version input configuration. +type PackageVersionInputConfig struct { + _ struct{} `type:"structure"` + + // A location in Amazon S3. + // + // S3Location is a required field + S3Location *S3Location `type:"structure" required:"true"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s PackageVersionInputConfig) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s PackageVersionInputConfig) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *PackageVersionInputConfig) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "PackageVersionInputConfig"} + if s.S3Location == nil { + invalidParams.Add(request.NewErrParamRequired("S3Location")) + } + if s.S3Location != nil { + if err := s.S3Location.Validate(); err != nil { + invalidParams.AddNested("S3Location", err.(request.ErrInvalidParams)) + } + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetS3Location sets the S3Location field's value. +func (s *PackageVersionInputConfig) SetS3Location(v *S3Location) *PackageVersionInputConfig { + s.S3Location = v + return s +} + +// A package version output configuration. +type PackageVersionOutputConfig struct { + _ struct{} `type:"structure"` + + // Indicates that the version is recommended for all users. + MarkLatest *bool `type:"boolean"` + + // The output's package name. + // + // PackageName is a required field + PackageName *string `min:"1" type:"string" required:"true"` + + // The output's package version. + // + // PackageVersion is a required field + PackageVersion *string `min:"1" type:"string" required:"true"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s PackageVersionOutputConfig) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s PackageVersionOutputConfig) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *PackageVersionOutputConfig) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "PackageVersionOutputConfig"} + if s.PackageName == nil { + invalidParams.Add(request.NewErrParamRequired("PackageName")) + } + if s.PackageName != nil && len(*s.PackageName) < 1 { + invalidParams.Add(request.NewErrParamMinLen("PackageName", 1)) + } + if s.PackageVersion == nil { + invalidParams.Add(request.NewErrParamRequired("PackageVersion")) + } + if s.PackageVersion != nil && len(*s.PackageVersion) < 1 { + invalidParams.Add(request.NewErrParamMinLen("PackageVersion", 1)) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetMarkLatest sets the MarkLatest field's value. +func (s *PackageVersionOutputConfig) SetMarkLatest(v bool) *PackageVersionOutputConfig { + s.MarkLatest = &v + return s +} + +// SetPackageName sets the PackageName field's value. +func (s *PackageVersionOutputConfig) SetPackageName(v string) *PackageVersionOutputConfig { + s.PackageName = &v + return s +} + +// SetPackageVersion sets the PackageVersion field's value. +func (s *PackageVersionOutputConfig) SetPackageVersion(v string) *PackageVersionOutputConfig { + s.PackageVersion = &v + return s +} + +type ProvisionDeviceInput struct { + _ struct{} `type:"structure"` + + // A description for the device. + Description *string `type:"string"` + + // A name for the device. + // + // Name is a required field + Name *string `min:"1" type:"string" required:"true"` + + // A networking configuration for the device. + NetworkingConfiguration *NetworkPayload `type:"structure"` + + // Tags for the device. + Tags map[string]*string `type:"map"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ProvisionDeviceInput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ProvisionDeviceInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *ProvisionDeviceInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "ProvisionDeviceInput"} + if s.Name == nil { + invalidParams.Add(request.NewErrParamRequired("Name")) + } + if s.Name != nil && len(*s.Name) < 1 { + invalidParams.Add(request.NewErrParamMinLen("Name", 1)) + } + if s.NetworkingConfiguration != nil { + if err := s.NetworkingConfiguration.Validate(); err != nil { + invalidParams.AddNested("NetworkingConfiguration", err.(request.ErrInvalidParams)) + } + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetDescription sets the Description field's value. +func (s *ProvisionDeviceInput) SetDescription(v string) *ProvisionDeviceInput { + s.Description = &v + return s +} + +// SetName sets the Name field's value. +func (s *ProvisionDeviceInput) SetName(v string) *ProvisionDeviceInput { + s.Name = &v + return s +} + +// SetNetworkingConfiguration sets the NetworkingConfiguration field's value. +func (s *ProvisionDeviceInput) SetNetworkingConfiguration(v *NetworkPayload) *ProvisionDeviceInput { + s.NetworkingConfiguration = v + return s +} + +// SetTags sets the Tags field's value. +func (s *ProvisionDeviceInput) SetTags(v map[string]*string) *ProvisionDeviceInput { + s.Tags = v + return s +} + +type ProvisionDeviceOutput struct { + _ struct{} `type:"structure"` + + // The device's ARN. + // + // Arn is a required field + Arn *string `min:"1" type:"string" required:"true"` + + // The device's configuration bundle. + // Certificates is automatically base64 encoded/decoded by the SDK. + Certificates []byte `type:"blob"` + + // The device's ID. + DeviceId *string `min:"1" type:"string"` + + // The device's IoT thing name. + IotThingName *string `min:"1" type:"string"` + + // The device's status. + // + // Status is a required field + Status *string `type:"string" required:"true" enum:"DeviceStatus"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ProvisionDeviceOutput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ProvisionDeviceOutput) GoString() string { + return s.String() +} + +// SetArn sets the Arn field's value. +func (s *ProvisionDeviceOutput) SetArn(v string) *ProvisionDeviceOutput { + s.Arn = &v + return s +} + +// SetCertificates sets the Certificates field's value. +func (s *ProvisionDeviceOutput) SetCertificates(v []byte) *ProvisionDeviceOutput { + s.Certificates = v + return s +} + +// SetDeviceId sets the DeviceId field's value. +func (s *ProvisionDeviceOutput) SetDeviceId(v string) *ProvisionDeviceOutput { + s.DeviceId = &v + return s +} + +// SetIotThingName sets the IotThingName field's value. +func (s *ProvisionDeviceOutput) SetIotThingName(v string) *ProvisionDeviceOutput { + s.IotThingName = &v + return s +} + +// SetStatus sets the Status field's value. +func (s *ProvisionDeviceOutput) SetStatus(v string) *ProvisionDeviceOutput { + s.Status = &v + return s +} + +type RegisterPackageVersionInput struct { + _ struct{} `type:"structure"` + + // Whether to mark the new version as the latest version. + MarkLatest *bool `type:"boolean"` + + // An owner account. + OwnerAccount *string `min:"1" type:"string"` + + // A package ID. + // + // PackageId is a required field + PackageId *string `location:"uri" locationName:"PackageId" min:"1" type:"string" required:"true"` + + // A package version. + // + // PackageVersion is a required field + PackageVersion *string `location:"uri" locationName:"PackageVersion" min:"1" type:"string" required:"true"` + + // A patch version. + // + // PatchVersion is a required field + PatchVersion *string `location:"uri" locationName:"PatchVersion" min:"1" type:"string" required:"true"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s RegisterPackageVersionInput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s RegisterPackageVersionInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *RegisterPackageVersionInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "RegisterPackageVersionInput"} + if s.OwnerAccount != nil && len(*s.OwnerAccount) < 1 { + invalidParams.Add(request.NewErrParamMinLen("OwnerAccount", 1)) + } + if s.PackageId == nil { + invalidParams.Add(request.NewErrParamRequired("PackageId")) + } + if s.PackageId != nil && len(*s.PackageId) < 1 { + invalidParams.Add(request.NewErrParamMinLen("PackageId", 1)) + } + if s.PackageVersion == nil { + invalidParams.Add(request.NewErrParamRequired("PackageVersion")) + } + if s.PackageVersion != nil && len(*s.PackageVersion) < 1 { + invalidParams.Add(request.NewErrParamMinLen("PackageVersion", 1)) + } + if s.PatchVersion == nil { + invalidParams.Add(request.NewErrParamRequired("PatchVersion")) + } + if s.PatchVersion != nil && len(*s.PatchVersion) < 1 { + invalidParams.Add(request.NewErrParamMinLen("PatchVersion", 1)) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetMarkLatest sets the MarkLatest field's value. +func (s *RegisterPackageVersionInput) SetMarkLatest(v bool) *RegisterPackageVersionInput { + s.MarkLatest = &v + return s +} + +// SetOwnerAccount sets the OwnerAccount field's value. +func (s *RegisterPackageVersionInput) SetOwnerAccount(v string) *RegisterPackageVersionInput { + s.OwnerAccount = &v + return s +} + +// SetPackageId sets the PackageId field's value. +func (s *RegisterPackageVersionInput) SetPackageId(v string) *RegisterPackageVersionInput { + s.PackageId = &v + return s +} + +// SetPackageVersion sets the PackageVersion field's value. +func (s *RegisterPackageVersionInput) SetPackageVersion(v string) *RegisterPackageVersionInput { + s.PackageVersion = &v + return s +} + +// SetPatchVersion sets the PatchVersion field's value. +func (s *RegisterPackageVersionInput) SetPatchVersion(v string) *RegisterPackageVersionInput { + s.PatchVersion = &v + return s +} + +type RegisterPackageVersionOutput struct { + _ struct{} `type:"structure"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s RegisterPackageVersionOutput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s RegisterPackageVersionOutput) GoString() string { + return s.String() +} + +type RemoveApplicationInstanceInput struct { + _ struct{} `type:"structure" nopayload:"true"` + + // An application instance ID. + // + // ApplicationInstanceId is a required field + ApplicationInstanceId *string `location:"uri" locationName:"applicationInstanceId" min:"1" type:"string" required:"true"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s RemoveApplicationInstanceInput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s RemoveApplicationInstanceInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *RemoveApplicationInstanceInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "RemoveApplicationInstanceInput"} + if s.ApplicationInstanceId == nil { + invalidParams.Add(request.NewErrParamRequired("ApplicationInstanceId")) + } + if s.ApplicationInstanceId != nil && len(*s.ApplicationInstanceId) < 1 { + invalidParams.Add(request.NewErrParamMinLen("ApplicationInstanceId", 1)) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetApplicationInstanceId sets the ApplicationInstanceId field's value. +func (s *RemoveApplicationInstanceInput) SetApplicationInstanceId(v string) *RemoveApplicationInstanceInput { + s.ApplicationInstanceId = &v + return s +} + +type RemoveApplicationInstanceOutput struct { + _ struct{} `type:"structure"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s RemoveApplicationInstanceOutput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s RemoveApplicationInstanceOutput) GoString() string { + return s.String() +} + +// The target resource was not found. +type ResourceNotFoundException struct { + _ struct{} `type:"structure"` + RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"` + + Message_ *string `locationName:"Message" type:"string"` + + // The resource's ID. + // + // ResourceId is a required field + ResourceId *string `type:"string" required:"true"` + + // The resource's type. + // + // ResourceType is a required field + ResourceType *string `type:"string" required:"true"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ResourceNotFoundException) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ResourceNotFoundException) GoString() string { + return s.String() +} + +func newErrorResourceNotFoundException(v protocol.ResponseMetadata) error { + return &ResourceNotFoundException{ + RespMetadata: v, + } +} + +// Code returns the exception type name. +func (s *ResourceNotFoundException) Code() string { + return "ResourceNotFoundException" +} + +// Message returns the exception's message. +func (s *ResourceNotFoundException) Message() string { + if s.Message_ != nil { + return *s.Message_ + } + return "" +} + +// OrigErr always returns nil, satisfies awserr.Error interface. +func (s *ResourceNotFoundException) OrigErr() error { + return nil +} + +func (s *ResourceNotFoundException) Error() string { + return fmt.Sprintf("%s: %s\n%s", s.Code(), s.Message(), s.String()) +} + +// Status code returns the HTTP status code for the request's response error. +func (s *ResourceNotFoundException) StatusCode() int { + return s.RespMetadata.StatusCode +} + +// RequestID returns the service's response RequestID for request. +func (s *ResourceNotFoundException) RequestID() string { + return s.RespMetadata.RequestID +} + +// A location in Amazon S3. +type S3Location struct { + _ struct{} `type:"structure"` + + // A bucket name. + // + // BucketName is a required field + BucketName *string `min:"1" type:"string" required:"true"` + + // An object key. + // + // ObjectKey is a required field + ObjectKey *string `min:"1" type:"string" required:"true"` + + // The bucket's Region. + Region *string `min:"1" type:"string"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s S3Location) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s S3Location) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *S3Location) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "S3Location"} + if s.BucketName == nil { + invalidParams.Add(request.NewErrParamRequired("BucketName")) + } + if s.BucketName != nil && len(*s.BucketName) < 1 { + invalidParams.Add(request.NewErrParamMinLen("BucketName", 1)) + } + if s.ObjectKey == nil { + invalidParams.Add(request.NewErrParamRequired("ObjectKey")) + } + if s.ObjectKey != nil && len(*s.ObjectKey) < 1 { + invalidParams.Add(request.NewErrParamMinLen("ObjectKey", 1)) + } + if s.Region != nil && len(*s.Region) < 1 { + invalidParams.Add(request.NewErrParamMinLen("Region", 1)) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetBucketName sets the BucketName field's value. +func (s *S3Location) SetBucketName(v string) *S3Location { + s.BucketName = &v + return s +} + +// SetObjectKey sets the ObjectKey field's value. +func (s *S3Location) SetObjectKey(v string) *S3Location { + s.ObjectKey = &v + return s +} + +// SetRegion sets the Region field's value. +func (s *S3Location) SetRegion(v string) *S3Location { + s.Region = &v + return s +} + +// The request would cause a limit to be exceeded. +type ServiceQuotaExceededException struct { + _ struct{} `type:"structure"` + RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"` + + Message_ *string `locationName:"Message" type:"string"` + + // The name of the limit. + // + // QuotaCode is a required field + QuotaCode *string `type:"string" required:"true"` + + // The target resource's ID. + ResourceId *string `type:"string"` + + // The target resource's type. + ResourceType *string `type:"string"` + + // The name of the service. + // + // ServiceCode is a required field + ServiceCode *string `type:"string" required:"true"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ServiceQuotaExceededException) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ServiceQuotaExceededException) GoString() string { + return s.String() +} + +func newErrorServiceQuotaExceededException(v protocol.ResponseMetadata) error { + return &ServiceQuotaExceededException{ + RespMetadata: v, + } +} + +// Code returns the exception type name. +func (s *ServiceQuotaExceededException) Code() string { + return "ServiceQuotaExceededException" +} + +// Message returns the exception's message. +func (s *ServiceQuotaExceededException) Message() string { + if s.Message_ != nil { + return *s.Message_ + } + return "" +} + +// OrigErr always returns nil, satisfies awserr.Error interface. +func (s *ServiceQuotaExceededException) OrigErr() error { + return nil +} + +func (s *ServiceQuotaExceededException) Error() string { + return fmt.Sprintf("%s: %s\n%s", s.Code(), s.Message(), s.String()) +} + +// Status code returns the HTTP status code for the request's response error. +func (s *ServiceQuotaExceededException) StatusCode() int { + return s.RespMetadata.StatusCode +} + +// RequestID returns the service's response RequestID for request. +func (s *ServiceQuotaExceededException) RequestID() string { + return s.RespMetadata.RequestID +} + +// A static IP configuration. +type StaticIpConnectionInfo struct { + _ struct{} `type:"structure"` + + // The connection's default gateway. + // + // DefaultGateway is a required field + DefaultGateway *string `min:"1" type:"string" required:"true"` + + // The connection's DNS address. + // + // Dns is a required field + Dns []*string `type:"list" required:"true"` + + // The connection's IP address. + // + // IpAddress is a required field + IpAddress *string `min:"1" type:"string" required:"true"` + + // The connection's DNS mask. + // + // Mask is a required field + Mask *string `min:"1" type:"string" required:"true"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s StaticIpConnectionInfo) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s StaticIpConnectionInfo) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *StaticIpConnectionInfo) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "StaticIpConnectionInfo"} + if s.DefaultGateway == nil { + invalidParams.Add(request.NewErrParamRequired("DefaultGateway")) + } + if s.DefaultGateway != nil && len(*s.DefaultGateway) < 1 { + invalidParams.Add(request.NewErrParamMinLen("DefaultGateway", 1)) + } + if s.Dns == nil { + invalidParams.Add(request.NewErrParamRequired("Dns")) + } + if s.IpAddress == nil { + invalidParams.Add(request.NewErrParamRequired("IpAddress")) + } + if s.IpAddress != nil && len(*s.IpAddress) < 1 { + invalidParams.Add(request.NewErrParamMinLen("IpAddress", 1)) + } + if s.Mask == nil { + invalidParams.Add(request.NewErrParamRequired("Mask")) + } + if s.Mask != nil && len(*s.Mask) < 1 { + invalidParams.Add(request.NewErrParamMinLen("Mask", 1)) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetDefaultGateway sets the DefaultGateway field's value. +func (s *StaticIpConnectionInfo) SetDefaultGateway(v string) *StaticIpConnectionInfo { + s.DefaultGateway = &v + return s +} + +// SetDns sets the Dns field's value. +func (s *StaticIpConnectionInfo) SetDns(v []*string) *StaticIpConnectionInfo { + s.Dns = v + return s +} + +// SetIpAddress sets the IpAddress field's value. +func (s *StaticIpConnectionInfo) SetIpAddress(v string) *StaticIpConnectionInfo { + s.IpAddress = &v + return s +} + +// SetMask sets the Mask field's value. +func (s *StaticIpConnectionInfo) SetMask(v string) *StaticIpConnectionInfo { + s.Mask = &v + return s +} + +// A storage location. +type StorageLocation struct { + _ struct{} `type:"structure"` + + // The location's binary prefix. + // + // BinaryPrefixLocation is a required field + BinaryPrefixLocation *string `type:"string" required:"true"` + + // The location's bucket. + // + // Bucket is a required field + Bucket *string `type:"string" required:"true"` + + // The location's generated prefix. + // + // GeneratedPrefixLocation is a required field + GeneratedPrefixLocation *string `type:"string" required:"true"` + + // The location's manifest prefix. + // + // ManifestPrefixLocation is a required field + ManifestPrefixLocation *string `type:"string" required:"true"` + + // The location's repo prefix. + // + // RepoPrefixLocation is a required field + RepoPrefixLocation *string `type:"string" required:"true"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s StorageLocation) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s StorageLocation) GoString() string { + return s.String() +} + +// SetBinaryPrefixLocation sets the BinaryPrefixLocation field's value. +func (s *StorageLocation) SetBinaryPrefixLocation(v string) *StorageLocation { + s.BinaryPrefixLocation = &v + return s +} + +// SetBucket sets the Bucket field's value. +func (s *StorageLocation) SetBucket(v string) *StorageLocation { + s.Bucket = &v + return s +} + +// SetGeneratedPrefixLocation sets the GeneratedPrefixLocation field's value. +func (s *StorageLocation) SetGeneratedPrefixLocation(v string) *StorageLocation { + s.GeneratedPrefixLocation = &v + return s +} + +// SetManifestPrefixLocation sets the ManifestPrefixLocation field's value. +func (s *StorageLocation) SetManifestPrefixLocation(v string) *StorageLocation { + s.ManifestPrefixLocation = &v + return s +} + +// SetRepoPrefixLocation sets the RepoPrefixLocation field's value. +func (s *StorageLocation) SetRepoPrefixLocation(v string) *StorageLocation { + s.RepoPrefixLocation = &v + return s +} + +type TagResourceInput struct { + _ struct{} `type:"structure"` + + // The resource's ARN. + // + // ResourceArn is a required field + ResourceArn *string `location:"uri" locationName:"ResourceArn" min:"1" type:"string" required:"true"` + + // Tags for the resource. + // + // Tags is a required field + Tags map[string]*string `type:"map" required:"true"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s TagResourceInput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s TagResourceInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *TagResourceInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "TagResourceInput"} + if s.ResourceArn == nil { + invalidParams.Add(request.NewErrParamRequired("ResourceArn")) + } + if s.ResourceArn != nil && len(*s.ResourceArn) < 1 { + invalidParams.Add(request.NewErrParamMinLen("ResourceArn", 1)) + } + if s.Tags == nil { + invalidParams.Add(request.NewErrParamRequired("Tags")) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetResourceArn sets the ResourceArn field's value. +func (s *TagResourceInput) SetResourceArn(v string) *TagResourceInput { + s.ResourceArn = &v + return s +} + +// SetTags sets the Tags field's value. +func (s *TagResourceInput) SetTags(v map[string]*string) *TagResourceInput { + s.Tags = v + return s +} + +type TagResourceOutput struct { + _ struct{} `type:"structure"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s TagResourceOutput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s TagResourceOutput) GoString() string { + return s.String() +} + +type UntagResourceInput struct { + _ struct{} `type:"structure" nopayload:"true"` + + // The resource's ARN. + // + // ResourceArn is a required field + ResourceArn *string `location:"uri" locationName:"ResourceArn" min:"1" type:"string" required:"true"` + + // Tag keys to remove. + // + // TagKeys is a required field + TagKeys []*string `location:"querystring" locationName:"tagKeys" min:"1" type:"list" required:"true"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s UntagResourceInput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s UntagResourceInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *UntagResourceInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "UntagResourceInput"} + if s.ResourceArn == nil { + invalidParams.Add(request.NewErrParamRequired("ResourceArn")) + } + if s.ResourceArn != nil && len(*s.ResourceArn) < 1 { + invalidParams.Add(request.NewErrParamMinLen("ResourceArn", 1)) + } + if s.TagKeys == nil { + invalidParams.Add(request.NewErrParamRequired("TagKeys")) + } + if s.TagKeys != nil && len(s.TagKeys) < 1 { + invalidParams.Add(request.NewErrParamMinLen("TagKeys", 1)) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetResourceArn sets the ResourceArn field's value. +func (s *UntagResourceInput) SetResourceArn(v string) *UntagResourceInput { + s.ResourceArn = &v + return s +} + +// SetTagKeys sets the TagKeys field's value. +func (s *UntagResourceInput) SetTagKeys(v []*string) *UntagResourceInput { + s.TagKeys = v + return s +} + +type UntagResourceOutput struct { + _ struct{} `type:"structure"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s UntagResourceOutput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s UntagResourceOutput) GoString() string { + return s.String() +} + +type UpdateDeviceMetadataInput struct { + _ struct{} `type:"structure"` + + // A description for the device. + Description *string `type:"string"` + + // The device's ID. + // + // DeviceId is a required field + DeviceId *string `location:"uri" locationName:"DeviceId" min:"1" type:"string" required:"true"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s UpdateDeviceMetadataInput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s UpdateDeviceMetadataInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *UpdateDeviceMetadataInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "UpdateDeviceMetadataInput"} + if s.DeviceId == nil { + invalidParams.Add(request.NewErrParamRequired("DeviceId")) + } + if s.DeviceId != nil && len(*s.DeviceId) < 1 { + invalidParams.Add(request.NewErrParamMinLen("DeviceId", 1)) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetDescription sets the Description field's value. +func (s *UpdateDeviceMetadataInput) SetDescription(v string) *UpdateDeviceMetadataInput { + s.Description = &v + return s +} + +// SetDeviceId sets the DeviceId field's value. +func (s *UpdateDeviceMetadataInput) SetDeviceId(v string) *UpdateDeviceMetadataInput { + s.DeviceId = &v + return s +} + +type UpdateDeviceMetadataOutput struct { + _ struct{} `type:"structure"` + + // The device's ID. + DeviceId *string `min:"1" type:"string"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s UpdateDeviceMetadataOutput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s UpdateDeviceMetadataOutput) GoString() string { + return s.String() +} + +// SetDeviceId sets the DeviceId field's value. +func (s *UpdateDeviceMetadataOutput) SetDeviceId(v string) *UpdateDeviceMetadataOutput { + s.DeviceId = &v + return s +} + +// The request contains an invalid parameter value. +type ValidationException struct { + _ struct{} `type:"structure"` + RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"` + + // A list of attributes that led to the exception and their values. + ErrorArguments []*ValidationExceptionErrorArgument `type:"list"` + + // A unique ID for the error. + ErrorId *string `type:"string"` + + // A list of request parameters that failed validation. + Fields []*ValidationExceptionField `type:"list"` + + Message_ *string `locationName:"Message" type:"string"` + + // The reason that validation failed. + Reason *string `type:"string" enum:"ValidationExceptionReason"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ValidationException) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ValidationException) GoString() string { + return s.String() +} + +func newErrorValidationException(v protocol.ResponseMetadata) error { + return &ValidationException{ + RespMetadata: v, + } +} + +// Code returns the exception type name. +func (s *ValidationException) Code() string { + return "ValidationException" +} + +// Message returns the exception's message. +func (s *ValidationException) Message() string { + if s.Message_ != nil { + return *s.Message_ + } + return "" +} + +// OrigErr always returns nil, satisfies awserr.Error interface. +func (s *ValidationException) OrigErr() error { + return nil +} + +func (s *ValidationException) Error() string { + return fmt.Sprintf("%s: %s\n%s", s.Code(), s.Message(), s.String()) +} + +// Status code returns the HTTP status code for the request's response error. +func (s *ValidationException) StatusCode() int { + return s.RespMetadata.StatusCode +} + +// RequestID returns the service's response RequestID for request. +func (s *ValidationException) RequestID() string { + return s.RespMetadata.RequestID +} + +// A validation exception error argument. +type ValidationExceptionErrorArgument struct { + _ struct{} `type:"structure"` + + // The argument's name. + // + // Name is a required field + Name *string `type:"string" required:"true"` + + // The argument's value. + // + // Value is a required field + Value *string `type:"string" required:"true"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ValidationExceptionErrorArgument) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ValidationExceptionErrorArgument) GoString() string { + return s.String() +} + +// SetName sets the Name field's value. +func (s *ValidationExceptionErrorArgument) SetName(v string) *ValidationExceptionErrorArgument { + s.Name = &v + return s +} + +// SetValue sets the Value field's value. +func (s *ValidationExceptionErrorArgument) SetValue(v string) *ValidationExceptionErrorArgument { + s.Value = &v + return s +} + +// A validation exception field. +type ValidationExceptionField struct { + _ struct{} `type:"structure"` + + // The field's message. + // + // Message is a required field + Message *string `type:"string" required:"true"` + + // The field's name. + // + // Name is a required field + Name *string `type:"string" required:"true"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ValidationExceptionField) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ValidationExceptionField) GoString() string { + return s.String() +} + +// SetMessage sets the Message field's value. +func (s *ValidationExceptionField) SetMessage(v string) *ValidationExceptionField { + s.Message = &v + return s +} + +// SetName sets the Name field's value. +func (s *ValidationExceptionField) SetName(v string) *ValidationExceptionField { + s.Name = &v + return s +} + +const ( + // ApplicationInstanceHealthStatusRunning is a ApplicationInstanceHealthStatus enum value + ApplicationInstanceHealthStatusRunning = "RUNNING" + + // ApplicationInstanceHealthStatusError is a ApplicationInstanceHealthStatus enum value + ApplicationInstanceHealthStatusError = "ERROR" + + // ApplicationInstanceHealthStatusNotAvailable is a ApplicationInstanceHealthStatus enum value + ApplicationInstanceHealthStatusNotAvailable = "NOT_AVAILABLE" +) + +// ApplicationInstanceHealthStatus_Values returns all elements of the ApplicationInstanceHealthStatus enum +func ApplicationInstanceHealthStatus_Values() []string { + return []string{ + ApplicationInstanceHealthStatusRunning, + ApplicationInstanceHealthStatusError, + ApplicationInstanceHealthStatusNotAvailable, + } +} + +const ( + // ApplicationInstanceStatusDeploymentPending is a ApplicationInstanceStatus enum value + ApplicationInstanceStatusDeploymentPending = "DEPLOYMENT_PENDING" + + // ApplicationInstanceStatusDeploymentRequested is a ApplicationInstanceStatus enum value + ApplicationInstanceStatusDeploymentRequested = "DEPLOYMENT_REQUESTED" + + // ApplicationInstanceStatusDeploymentInProgress is a ApplicationInstanceStatus enum value + ApplicationInstanceStatusDeploymentInProgress = "DEPLOYMENT_IN_PROGRESS" + + // ApplicationInstanceStatusDeploymentError is a ApplicationInstanceStatus enum value + ApplicationInstanceStatusDeploymentError = "DEPLOYMENT_ERROR" + + // ApplicationInstanceStatusDeploymentSucceeded is a ApplicationInstanceStatus enum value + ApplicationInstanceStatusDeploymentSucceeded = "DEPLOYMENT_SUCCEEDED" + + // ApplicationInstanceStatusRemovalPending is a ApplicationInstanceStatus enum value + ApplicationInstanceStatusRemovalPending = "REMOVAL_PENDING" + + // ApplicationInstanceStatusRemovalRequested is a ApplicationInstanceStatus enum value + ApplicationInstanceStatusRemovalRequested = "REMOVAL_REQUESTED" + + // ApplicationInstanceStatusRemovalInProgress is a ApplicationInstanceStatus enum value + ApplicationInstanceStatusRemovalInProgress = "REMOVAL_IN_PROGRESS" + + // ApplicationInstanceStatusRemovalFailed is a ApplicationInstanceStatus enum value + ApplicationInstanceStatusRemovalFailed = "REMOVAL_FAILED" + + // ApplicationInstanceStatusRemovalSucceeded is a ApplicationInstanceStatus enum value + ApplicationInstanceStatusRemovalSucceeded = "REMOVAL_SUCCEEDED" +) + +// ApplicationInstanceStatus_Values returns all elements of the ApplicationInstanceStatus enum +func ApplicationInstanceStatus_Values() []string { + return []string{ + ApplicationInstanceStatusDeploymentPending, + ApplicationInstanceStatusDeploymentRequested, + ApplicationInstanceStatusDeploymentInProgress, + ApplicationInstanceStatusDeploymentError, + ApplicationInstanceStatusDeploymentSucceeded, + ApplicationInstanceStatusRemovalPending, + ApplicationInstanceStatusRemovalRequested, + ApplicationInstanceStatusRemovalInProgress, + ApplicationInstanceStatusRemovalFailed, + ApplicationInstanceStatusRemovalSucceeded, + } +} + +const ( + // ConnectionTypeStaticIp is a ConnectionType enum value + ConnectionTypeStaticIp = "STATIC_IP" + + // ConnectionTypeDhcp is a ConnectionType enum value + ConnectionTypeDhcp = "DHCP" +) + +// ConnectionType_Values returns all elements of the ConnectionType enum +func ConnectionType_Values() []string { + return []string{ + ConnectionTypeStaticIp, + ConnectionTypeDhcp, + } +} + +const ( + // DeviceConnectionStatusOnline is a DeviceConnectionStatus enum value + DeviceConnectionStatusOnline = "ONLINE" + + // DeviceConnectionStatusOffline is a DeviceConnectionStatus enum value + DeviceConnectionStatusOffline = "OFFLINE" + + // DeviceConnectionStatusAwaitingCredentials is a DeviceConnectionStatus enum value + DeviceConnectionStatusAwaitingCredentials = "AWAITING_CREDENTIALS" + + // DeviceConnectionStatusNotAvailable is a DeviceConnectionStatus enum value + DeviceConnectionStatusNotAvailable = "NOT_AVAILABLE" + + // DeviceConnectionStatusError is a DeviceConnectionStatus enum value + DeviceConnectionStatusError = "ERROR" +) + +// DeviceConnectionStatus_Values returns all elements of the DeviceConnectionStatus enum +func DeviceConnectionStatus_Values() []string { + return []string{ + DeviceConnectionStatusOnline, + DeviceConnectionStatusOffline, + DeviceConnectionStatusAwaitingCredentials, + DeviceConnectionStatusNotAvailable, + DeviceConnectionStatusError, + } +} + +const ( + // DeviceStatusAwaitingProvisioning is a DeviceStatus enum value + DeviceStatusAwaitingProvisioning = "AWAITING_PROVISIONING" + + // DeviceStatusPending is a DeviceStatus enum value + DeviceStatusPending = "PENDING" + + // DeviceStatusSucceeded is a DeviceStatus enum value + DeviceStatusSucceeded = "SUCCEEDED" + + // DeviceStatusFailed is a DeviceStatus enum value + DeviceStatusFailed = "FAILED" + + // DeviceStatusError is a DeviceStatus enum value + DeviceStatusError = "ERROR" + + // DeviceStatusDeleting is a DeviceStatus enum value + DeviceStatusDeleting = "DELETING" +) + +// DeviceStatus_Values returns all elements of the DeviceStatus enum +func DeviceStatus_Values() []string { + return []string{ + DeviceStatusAwaitingProvisioning, + DeviceStatusPending, + DeviceStatusSucceeded, + DeviceStatusFailed, + DeviceStatusError, + DeviceStatusDeleting, + } +} + +const ( + // DeviceTypePanoramaApplianceDeveloperKit is a DeviceType enum value + DeviceTypePanoramaApplianceDeveloperKit = "PANORAMA_APPLIANCE_DEVELOPER_KIT" + + // DeviceTypePanoramaAppliance is a DeviceType enum value + DeviceTypePanoramaAppliance = "PANORAMA_APPLIANCE" +) + +// DeviceType_Values returns all elements of the DeviceType enum +func DeviceType_Values() []string { + return []string{ + DeviceTypePanoramaApplianceDeveloperKit, + DeviceTypePanoramaAppliance, + } +} + +const ( + // JobResourceTypePackage is a JobResourceType enum value + JobResourceTypePackage = "PACKAGE" +) + +// JobResourceType_Values returns all elements of the JobResourceType enum +func JobResourceType_Values() []string { + return []string{ + JobResourceTypePackage, + } +} + +const ( + // JobTypeOta is a JobType enum value + JobTypeOta = "OTA" +) + +// JobType_Values returns all elements of the JobType enum +func JobType_Values() []string { + return []string{ + JobTypeOta, + } +} + +const ( + // NetworkConnectionStatusConnected is a NetworkConnectionStatus enum value + NetworkConnectionStatusConnected = "CONNECTED" + + // NetworkConnectionStatusNotConnected is a NetworkConnectionStatus enum value + NetworkConnectionStatusNotConnected = "NOT_CONNECTED" +) + +// NetworkConnectionStatus_Values returns all elements of the NetworkConnectionStatus enum +func NetworkConnectionStatus_Values() []string { + return []string{ + NetworkConnectionStatusConnected, + NetworkConnectionStatusNotConnected, + } +} + +const ( + // NodeCategoryBusinessLogic is a NodeCategory enum value + NodeCategoryBusinessLogic = "BUSINESS_LOGIC" + + // NodeCategoryMlModel is a NodeCategory enum value + NodeCategoryMlModel = "ML_MODEL" + + // NodeCategoryMediaSource is a NodeCategory enum value + NodeCategoryMediaSource = "MEDIA_SOURCE" + + // NodeCategoryMediaSink is a NodeCategory enum value + NodeCategoryMediaSink = "MEDIA_SINK" +) + +// NodeCategory_Values returns all elements of the NodeCategory enum +func NodeCategory_Values() []string { + return []string{ + NodeCategoryBusinessLogic, + NodeCategoryMlModel, + NodeCategoryMediaSource, + NodeCategoryMediaSink, + } +} + +const ( + // NodeFromTemplateJobStatusPending is a NodeFromTemplateJobStatus enum value + NodeFromTemplateJobStatusPending = "PENDING" + + // NodeFromTemplateJobStatusSucceeded is a NodeFromTemplateJobStatus enum value + NodeFromTemplateJobStatusSucceeded = "SUCCEEDED" + + // NodeFromTemplateJobStatusFailed is a NodeFromTemplateJobStatus enum value + NodeFromTemplateJobStatusFailed = "FAILED" +) + +// NodeFromTemplateJobStatus_Values returns all elements of the NodeFromTemplateJobStatus enum +func NodeFromTemplateJobStatus_Values() []string { + return []string{ + NodeFromTemplateJobStatusPending, + NodeFromTemplateJobStatusSucceeded, + NodeFromTemplateJobStatusFailed, + } +} + +const ( + // NodeInstanceStatusRunning is a NodeInstanceStatus enum value + NodeInstanceStatusRunning = "RUNNING" + + // NodeInstanceStatusError is a NodeInstanceStatus enum value + NodeInstanceStatusError = "ERROR" + + // NodeInstanceStatusNotAvailable is a NodeInstanceStatus enum value + NodeInstanceStatusNotAvailable = "NOT_AVAILABLE" +) + +// NodeInstanceStatus_Values returns all elements of the NodeInstanceStatus enum +func NodeInstanceStatus_Values() []string { + return []string{ + NodeInstanceStatusRunning, + NodeInstanceStatusError, + NodeInstanceStatusNotAvailable, + } +} + +const ( + // PackageImportJobStatusPending is a PackageImportJobStatus enum value + PackageImportJobStatusPending = "PENDING" + + // PackageImportJobStatusSucceeded is a PackageImportJobStatus enum value + PackageImportJobStatusSucceeded = "SUCCEEDED" + + // PackageImportJobStatusFailed is a PackageImportJobStatus enum value + PackageImportJobStatusFailed = "FAILED" +) + +// PackageImportJobStatus_Values returns all elements of the PackageImportJobStatus enum +func PackageImportJobStatus_Values() []string { + return []string{ + PackageImportJobStatusPending, + PackageImportJobStatusSucceeded, + PackageImportJobStatusFailed, + } +} + +const ( + // PackageImportJobTypeNodePackageVersion is a PackageImportJobType enum value + PackageImportJobTypeNodePackageVersion = "NODE_PACKAGE_VERSION" +) + +// PackageImportJobType_Values returns all elements of the PackageImportJobType enum +func PackageImportJobType_Values() []string { + return []string{ + PackageImportJobTypeNodePackageVersion, + } +} + +const ( + // PackageVersionStatusRegisterPending is a PackageVersionStatus enum value + PackageVersionStatusRegisterPending = "REGISTER_PENDING" + + // PackageVersionStatusRegisterCompleted is a PackageVersionStatus enum value + PackageVersionStatusRegisterCompleted = "REGISTER_COMPLETED" + + // PackageVersionStatusFailed is a PackageVersionStatus enum value + PackageVersionStatusFailed = "FAILED" + + // PackageVersionStatusDeleting is a PackageVersionStatus enum value + PackageVersionStatusDeleting = "DELETING" +) + +// PackageVersionStatus_Values returns all elements of the PackageVersionStatus enum +func PackageVersionStatus_Values() []string { + return []string{ + PackageVersionStatusRegisterPending, + PackageVersionStatusRegisterCompleted, + PackageVersionStatusFailed, + PackageVersionStatusDeleting, + } +} + +const ( + // PortTypeBoolean is a PortType enum value + PortTypeBoolean = "BOOLEAN" + + // PortTypeString is a PortType enum value + PortTypeString = "STRING" + + // PortTypeInt32 is a PortType enum value + PortTypeInt32 = "INT32" + + // PortTypeFloat32 is a PortType enum value + PortTypeFloat32 = "FLOAT32" + + // PortTypeMedia is a PortType enum value + PortTypeMedia = "MEDIA" +) + +// PortType_Values returns all elements of the PortType enum +func PortType_Values() []string { + return []string{ + PortTypeBoolean, + PortTypeString, + PortTypeInt32, + PortTypeFloat32, + PortTypeMedia, + } +} + +const ( + // StatusFilterDeploymentSucceeded is a StatusFilter enum value + StatusFilterDeploymentSucceeded = "DEPLOYMENT_SUCCEEDED" + + // StatusFilterDeploymentError is a StatusFilter enum value + StatusFilterDeploymentError = "DEPLOYMENT_ERROR" + + // StatusFilterRemovalSucceeded is a StatusFilter enum value + StatusFilterRemovalSucceeded = "REMOVAL_SUCCEEDED" + + // StatusFilterRemovalFailed is a StatusFilter enum value + StatusFilterRemovalFailed = "REMOVAL_FAILED" + + // StatusFilterProcessingDeployment is a StatusFilter enum value + StatusFilterProcessingDeployment = "PROCESSING_DEPLOYMENT" + + // StatusFilterProcessingRemoval is a StatusFilter enum value + StatusFilterProcessingRemoval = "PROCESSING_REMOVAL" +) + +// StatusFilter_Values returns all elements of the StatusFilter enum +func StatusFilter_Values() []string { + return []string{ + StatusFilterDeploymentSucceeded, + StatusFilterDeploymentError, + StatusFilterRemovalSucceeded, + StatusFilterRemovalFailed, + StatusFilterProcessingDeployment, + StatusFilterProcessingRemoval, + } +} + +const ( + // TemplateTypeRtspCameraStream is a TemplateType enum value + TemplateTypeRtspCameraStream = "RTSP_CAMERA_STREAM" +) + +// TemplateType_Values returns all elements of the TemplateType enum +func TemplateType_Values() []string { + return []string{ + TemplateTypeRtspCameraStream, + } +} + +const ( + // UpdateProgressPending is a UpdateProgress enum value + UpdateProgressPending = "PENDING" + + // UpdateProgressInProgress is a UpdateProgress enum value + UpdateProgressInProgress = "IN_PROGRESS" + + // UpdateProgressVerifying is a UpdateProgress enum value + UpdateProgressVerifying = "VERIFYING" + + // UpdateProgressRebooting is a UpdateProgress enum value + UpdateProgressRebooting = "REBOOTING" + + // UpdateProgressDownloading is a UpdateProgress enum value + UpdateProgressDownloading = "DOWNLOADING" + + // UpdateProgressCompleted is a UpdateProgress enum value + UpdateProgressCompleted = "COMPLETED" + + // UpdateProgressFailed is a UpdateProgress enum value + UpdateProgressFailed = "FAILED" +) + +// UpdateProgress_Values returns all elements of the UpdateProgress enum +func UpdateProgress_Values() []string { + return []string{ + UpdateProgressPending, + UpdateProgressInProgress, + UpdateProgressVerifying, + UpdateProgressRebooting, + UpdateProgressDownloading, + UpdateProgressCompleted, + UpdateProgressFailed, + } +} + +const ( + // ValidationExceptionReasonUnknownOperation is a ValidationExceptionReason enum value + ValidationExceptionReasonUnknownOperation = "UNKNOWN_OPERATION" + + // ValidationExceptionReasonCannotParse is a ValidationExceptionReason enum value + ValidationExceptionReasonCannotParse = "CANNOT_PARSE" + + // ValidationExceptionReasonFieldValidationFailed is a ValidationExceptionReason enum value + ValidationExceptionReasonFieldValidationFailed = "FIELD_VALIDATION_FAILED" + + // ValidationExceptionReasonOther is a ValidationExceptionReason enum value + ValidationExceptionReasonOther = "OTHER" +) + +// ValidationExceptionReason_Values returns all elements of the ValidationExceptionReason enum +func ValidationExceptionReason_Values() []string { + return []string{ + ValidationExceptionReasonUnknownOperation, + ValidationExceptionReasonCannotParse, + ValidationExceptionReasonFieldValidationFailed, + ValidationExceptionReasonOther, + } +} diff --git a/service/panorama/doc.go b/service/panorama/doc.go new file mode 100644 index 0000000000..a5d1e3dcc9 --- /dev/null +++ b/service/panorama/doc.go @@ -0,0 +1,32 @@ +// Code generated by private/model/cli/gen-api/main.go. DO NOT EDIT. + +// Package panorama provides the client and types for making API +// requests to AWS Panorama. +// +// Overview +// +// This is the AWS Panorama API Reference. For an introduction to the service, +// see What is AWS Panorama? (https://docs.aws.amazon.com/panorama/latest/dev/panorama-welcome.html) +// in the AWS Panorama Developer Guide. +// +// See https://docs.aws.amazon.com/goto/WebAPI/panorama-2019-07-24 for more information on this service. +// +// See panorama package documentation for more information. +// https://docs.aws.amazon.com/sdk-for-go/api/service/panorama/ +// +// Using the Client +// +// To contact AWS Panorama with the SDK use the New function to create +// a new service client. With that client you can make API requests to the service. +// These clients are safe to use concurrently. +// +// See the SDK's documentation for more information on how to use the SDK. +// https://docs.aws.amazon.com/sdk-for-go/api/ +// +// See aws.Config documentation for more information on configuring SDK clients. +// https://docs.aws.amazon.com/sdk-for-go/api/aws/#Config +// +// See the AWS Panorama client Panorama for more +// information on creating client for this service. +// https://docs.aws.amazon.com/sdk-for-go/api/service/panorama/#New +package panorama diff --git a/service/panorama/errors.go b/service/panorama/errors.go new file mode 100644 index 0000000000..d74f666da2 --- /dev/null +++ b/service/panorama/errors.go @@ -0,0 +1,55 @@ +// Code generated by private/model/cli/gen-api/main.go. DO NOT EDIT. + +package panorama + +import ( + "github.com/aws/aws-sdk-go/private/protocol" +) + +const ( + + // ErrCodeAccessDeniedException for service response error code + // "AccessDeniedException". + // + // The requestor does not have permission to access the target action or resource. + ErrCodeAccessDeniedException = "AccessDeniedException" + + // ErrCodeConflictException for service response error code + // "ConflictException". + // + // The target resource is in use. + ErrCodeConflictException = "ConflictException" + + // ErrCodeInternalServerException for service response error code + // "InternalServerException". + // + // An internal error occurred. + ErrCodeInternalServerException = "InternalServerException" + + // ErrCodeResourceNotFoundException for service response error code + // "ResourceNotFoundException". + // + // The target resource was not found. + ErrCodeResourceNotFoundException = "ResourceNotFoundException" + + // ErrCodeServiceQuotaExceededException for service response error code + // "ServiceQuotaExceededException". + // + // The request would cause a limit to be exceeded. + ErrCodeServiceQuotaExceededException = "ServiceQuotaExceededException" + + // ErrCodeValidationException for service response error code + // "ValidationException". + // + // The request contains an invalid parameter value. + ErrCodeValidationException = "ValidationException" +) + +var exceptionFromCode = map[string]func(protocol.ResponseMetadata) error{ + "AccessDeniedException": newErrorAccessDeniedException, + "ConflictException": newErrorConflictException, + "InternalServerException": newErrorInternalServerException, + "ResourceNotFoundException": newErrorResourceNotFoundException, + "ServiceQuotaExceededException": newErrorServiceQuotaExceededException, + "ValidationException": newErrorValidationException, +} diff --git a/service/panorama/panoramaiface/interface.go b/service/panorama/panoramaiface/interface.go new file mode 100644 index 0000000000..b1733dc463 --- /dev/null +++ b/service/panorama/panoramaiface/interface.go @@ -0,0 +1,223 @@ +// Code generated by private/model/cli/gen-api/main.go. DO NOT EDIT. + +// Package panoramaiface provides an interface to enable mocking the AWS Panorama service client +// for testing your code. +// +// It is important to note that this interface will have breaking changes +// when the service model is updated and adds new API operations, paginators, +// and waiters. +package panoramaiface + +import ( + "github.com/aws/aws-sdk-go/aws" + "github.com/aws/aws-sdk-go/aws/request" + "github.com/aws/aws-sdk-go/service/panorama" +) + +// PanoramaAPI provides an interface to enable mocking the +// panorama.Panorama service client's API operation, +// paginators, and waiters. This make unit testing your code that calls out +// to the SDK's service client's calls easier. +// +// The best way to use this interface is so the SDK's service client's calls +// can be stubbed out for unit testing your code with the SDK without needing +// to inject custom request handlers into the SDK's request pipeline. +// +// // myFunc uses an SDK service client to make a request to +// // AWS Panorama. +// func myFunc(svc panoramaiface.PanoramaAPI) bool { +// // Make svc.CreateApplicationInstance request +// } +// +// func main() { +// sess := session.New() +// svc := panorama.New(sess) +// +// myFunc(svc) +// } +// +// In your _test.go file: +// +// // Define a mock struct to be used in your unit tests of myFunc. +// type mockPanoramaClient struct { +// panoramaiface.PanoramaAPI +// } +// func (m *mockPanoramaClient) CreateApplicationInstance(input *panorama.CreateApplicationInstanceInput) (*panorama.CreateApplicationInstanceOutput, error) { +// // mock response/functionality +// } +// +// func TestMyFunc(t *testing.T) { +// // Setup Test +// mockSvc := &mockPanoramaClient{} +// +// myfunc(mockSvc) +// +// // Verify myFunc's functionality +// } +// +// It is important to note that this interface will have breaking changes +// when the service model is updated and adds new API operations, paginators, +// and waiters. Its suggested to use the pattern above for testing, or using +// tooling to generate mocks to satisfy the interfaces. +type PanoramaAPI interface { + CreateApplicationInstance(*panorama.CreateApplicationInstanceInput) (*panorama.CreateApplicationInstanceOutput, error) + CreateApplicationInstanceWithContext(aws.Context, *panorama.CreateApplicationInstanceInput, ...request.Option) (*panorama.CreateApplicationInstanceOutput, error) + CreateApplicationInstanceRequest(*panorama.CreateApplicationInstanceInput) (*request.Request, *panorama.CreateApplicationInstanceOutput) + + CreateJobForDevices(*panorama.CreateJobForDevicesInput) (*panorama.CreateJobForDevicesOutput, error) + CreateJobForDevicesWithContext(aws.Context, *panorama.CreateJobForDevicesInput, ...request.Option) (*panorama.CreateJobForDevicesOutput, error) + CreateJobForDevicesRequest(*panorama.CreateJobForDevicesInput) (*request.Request, *panorama.CreateJobForDevicesOutput) + + CreateNodeFromTemplateJob(*panorama.CreateNodeFromTemplateJobInput) (*panorama.CreateNodeFromTemplateJobOutput, error) + CreateNodeFromTemplateJobWithContext(aws.Context, *panorama.CreateNodeFromTemplateJobInput, ...request.Option) (*panorama.CreateNodeFromTemplateJobOutput, error) + CreateNodeFromTemplateJobRequest(*panorama.CreateNodeFromTemplateJobInput) (*request.Request, *panorama.CreateNodeFromTemplateJobOutput) + + CreatePackage(*panorama.CreatePackageInput) (*panorama.CreatePackageOutput, error) + CreatePackageWithContext(aws.Context, *panorama.CreatePackageInput, ...request.Option) (*panorama.CreatePackageOutput, error) + CreatePackageRequest(*panorama.CreatePackageInput) (*request.Request, *panorama.CreatePackageOutput) + + CreatePackageImportJob(*panorama.CreatePackageImportJobInput) (*panorama.CreatePackageImportJobOutput, error) + CreatePackageImportJobWithContext(aws.Context, *panorama.CreatePackageImportJobInput, ...request.Option) (*panorama.CreatePackageImportJobOutput, error) + CreatePackageImportJobRequest(*panorama.CreatePackageImportJobInput) (*request.Request, *panorama.CreatePackageImportJobOutput) + + DeleteDevice(*panorama.DeleteDeviceInput) (*panorama.DeleteDeviceOutput, error) + DeleteDeviceWithContext(aws.Context, *panorama.DeleteDeviceInput, ...request.Option) (*panorama.DeleteDeviceOutput, error) + DeleteDeviceRequest(*panorama.DeleteDeviceInput) (*request.Request, *panorama.DeleteDeviceOutput) + + DeletePackage(*panorama.DeletePackageInput) (*panorama.DeletePackageOutput, error) + DeletePackageWithContext(aws.Context, *panorama.DeletePackageInput, ...request.Option) (*panorama.DeletePackageOutput, error) + DeletePackageRequest(*panorama.DeletePackageInput) (*request.Request, *panorama.DeletePackageOutput) + + DeregisterPackageVersion(*panorama.DeregisterPackageVersionInput) (*panorama.DeregisterPackageVersionOutput, error) + DeregisterPackageVersionWithContext(aws.Context, *panorama.DeregisterPackageVersionInput, ...request.Option) (*panorama.DeregisterPackageVersionOutput, error) + DeregisterPackageVersionRequest(*panorama.DeregisterPackageVersionInput) (*request.Request, *panorama.DeregisterPackageVersionOutput) + + DescribeApplicationInstance(*panorama.DescribeApplicationInstanceInput) (*panorama.DescribeApplicationInstanceOutput, error) + DescribeApplicationInstanceWithContext(aws.Context, *panorama.DescribeApplicationInstanceInput, ...request.Option) (*panorama.DescribeApplicationInstanceOutput, error) + DescribeApplicationInstanceRequest(*panorama.DescribeApplicationInstanceInput) (*request.Request, *panorama.DescribeApplicationInstanceOutput) + + DescribeApplicationInstanceDetails(*panorama.DescribeApplicationInstanceDetailsInput) (*panorama.DescribeApplicationInstanceDetailsOutput, error) + DescribeApplicationInstanceDetailsWithContext(aws.Context, *panorama.DescribeApplicationInstanceDetailsInput, ...request.Option) (*panorama.DescribeApplicationInstanceDetailsOutput, error) + DescribeApplicationInstanceDetailsRequest(*panorama.DescribeApplicationInstanceDetailsInput) (*request.Request, *panorama.DescribeApplicationInstanceDetailsOutput) + + DescribeDevice(*panorama.DescribeDeviceInput) (*panorama.DescribeDeviceOutput, error) + DescribeDeviceWithContext(aws.Context, *panorama.DescribeDeviceInput, ...request.Option) (*panorama.DescribeDeviceOutput, error) + DescribeDeviceRequest(*panorama.DescribeDeviceInput) (*request.Request, *panorama.DescribeDeviceOutput) + + DescribeDeviceJob(*panorama.DescribeDeviceJobInput) (*panorama.DescribeDeviceJobOutput, error) + DescribeDeviceJobWithContext(aws.Context, *panorama.DescribeDeviceJobInput, ...request.Option) (*panorama.DescribeDeviceJobOutput, error) + DescribeDeviceJobRequest(*panorama.DescribeDeviceJobInput) (*request.Request, *panorama.DescribeDeviceJobOutput) + + DescribeNode(*panorama.DescribeNodeInput) (*panorama.DescribeNodeOutput, error) + DescribeNodeWithContext(aws.Context, *panorama.DescribeNodeInput, ...request.Option) (*panorama.DescribeNodeOutput, error) + DescribeNodeRequest(*panorama.DescribeNodeInput) (*request.Request, *panorama.DescribeNodeOutput) + + DescribeNodeFromTemplateJob(*panorama.DescribeNodeFromTemplateJobInput) (*panorama.DescribeNodeFromTemplateJobOutput, error) + DescribeNodeFromTemplateJobWithContext(aws.Context, *panorama.DescribeNodeFromTemplateJobInput, ...request.Option) (*panorama.DescribeNodeFromTemplateJobOutput, error) + DescribeNodeFromTemplateJobRequest(*panorama.DescribeNodeFromTemplateJobInput) (*request.Request, *panorama.DescribeNodeFromTemplateJobOutput) + + DescribePackage(*panorama.DescribePackageInput) (*panorama.DescribePackageOutput, error) + DescribePackageWithContext(aws.Context, *panorama.DescribePackageInput, ...request.Option) (*panorama.DescribePackageOutput, error) + DescribePackageRequest(*panorama.DescribePackageInput) (*request.Request, *panorama.DescribePackageOutput) + + DescribePackageImportJob(*panorama.DescribePackageImportJobInput) (*panorama.DescribePackageImportJobOutput, error) + DescribePackageImportJobWithContext(aws.Context, *panorama.DescribePackageImportJobInput, ...request.Option) (*panorama.DescribePackageImportJobOutput, error) + DescribePackageImportJobRequest(*panorama.DescribePackageImportJobInput) (*request.Request, *panorama.DescribePackageImportJobOutput) + + DescribePackageVersion(*panorama.DescribePackageVersionInput) (*panorama.DescribePackageVersionOutput, error) + DescribePackageVersionWithContext(aws.Context, *panorama.DescribePackageVersionInput, ...request.Option) (*panorama.DescribePackageVersionOutput, error) + DescribePackageVersionRequest(*panorama.DescribePackageVersionInput) (*request.Request, *panorama.DescribePackageVersionOutput) + + ListApplicationInstanceDependencies(*panorama.ListApplicationInstanceDependenciesInput) (*panorama.ListApplicationInstanceDependenciesOutput, error) + ListApplicationInstanceDependenciesWithContext(aws.Context, *panorama.ListApplicationInstanceDependenciesInput, ...request.Option) (*panorama.ListApplicationInstanceDependenciesOutput, error) + ListApplicationInstanceDependenciesRequest(*panorama.ListApplicationInstanceDependenciesInput) (*request.Request, *panorama.ListApplicationInstanceDependenciesOutput) + + ListApplicationInstanceDependenciesPages(*panorama.ListApplicationInstanceDependenciesInput, func(*panorama.ListApplicationInstanceDependenciesOutput, bool) bool) error + ListApplicationInstanceDependenciesPagesWithContext(aws.Context, *panorama.ListApplicationInstanceDependenciesInput, func(*panorama.ListApplicationInstanceDependenciesOutput, bool) bool, ...request.Option) error + + ListApplicationInstanceNodeInstances(*panorama.ListApplicationInstanceNodeInstancesInput) (*panorama.ListApplicationInstanceNodeInstancesOutput, error) + ListApplicationInstanceNodeInstancesWithContext(aws.Context, *panorama.ListApplicationInstanceNodeInstancesInput, ...request.Option) (*panorama.ListApplicationInstanceNodeInstancesOutput, error) + ListApplicationInstanceNodeInstancesRequest(*panorama.ListApplicationInstanceNodeInstancesInput) (*request.Request, *panorama.ListApplicationInstanceNodeInstancesOutput) + + ListApplicationInstanceNodeInstancesPages(*panorama.ListApplicationInstanceNodeInstancesInput, func(*panorama.ListApplicationInstanceNodeInstancesOutput, bool) bool) error + ListApplicationInstanceNodeInstancesPagesWithContext(aws.Context, *panorama.ListApplicationInstanceNodeInstancesInput, func(*panorama.ListApplicationInstanceNodeInstancesOutput, bool) bool, ...request.Option) error + + ListApplicationInstances(*panorama.ListApplicationInstancesInput) (*panorama.ListApplicationInstancesOutput, error) + ListApplicationInstancesWithContext(aws.Context, *panorama.ListApplicationInstancesInput, ...request.Option) (*panorama.ListApplicationInstancesOutput, error) + ListApplicationInstancesRequest(*panorama.ListApplicationInstancesInput) (*request.Request, *panorama.ListApplicationInstancesOutput) + + ListApplicationInstancesPages(*panorama.ListApplicationInstancesInput, func(*panorama.ListApplicationInstancesOutput, bool) bool) error + ListApplicationInstancesPagesWithContext(aws.Context, *panorama.ListApplicationInstancesInput, func(*panorama.ListApplicationInstancesOutput, bool) bool, ...request.Option) error + + ListDevices(*panorama.ListDevicesInput) (*panorama.ListDevicesOutput, error) + ListDevicesWithContext(aws.Context, *panorama.ListDevicesInput, ...request.Option) (*panorama.ListDevicesOutput, error) + ListDevicesRequest(*panorama.ListDevicesInput) (*request.Request, *panorama.ListDevicesOutput) + + ListDevicesPages(*panorama.ListDevicesInput, func(*panorama.ListDevicesOutput, bool) bool) error + ListDevicesPagesWithContext(aws.Context, *panorama.ListDevicesInput, func(*panorama.ListDevicesOutput, bool) bool, ...request.Option) error + + ListDevicesJobs(*panorama.ListDevicesJobsInput) (*panorama.ListDevicesJobsOutput, error) + ListDevicesJobsWithContext(aws.Context, *panorama.ListDevicesJobsInput, ...request.Option) (*panorama.ListDevicesJobsOutput, error) + ListDevicesJobsRequest(*panorama.ListDevicesJobsInput) (*request.Request, *panorama.ListDevicesJobsOutput) + + ListDevicesJobsPages(*panorama.ListDevicesJobsInput, func(*panorama.ListDevicesJobsOutput, bool) bool) error + ListDevicesJobsPagesWithContext(aws.Context, *panorama.ListDevicesJobsInput, func(*panorama.ListDevicesJobsOutput, bool) bool, ...request.Option) error + + ListNodeFromTemplateJobs(*panorama.ListNodeFromTemplateJobsInput) (*panorama.ListNodeFromTemplateJobsOutput, error) + ListNodeFromTemplateJobsWithContext(aws.Context, *panorama.ListNodeFromTemplateJobsInput, ...request.Option) (*panorama.ListNodeFromTemplateJobsOutput, error) + ListNodeFromTemplateJobsRequest(*panorama.ListNodeFromTemplateJobsInput) (*request.Request, *panorama.ListNodeFromTemplateJobsOutput) + + ListNodeFromTemplateJobsPages(*panorama.ListNodeFromTemplateJobsInput, func(*panorama.ListNodeFromTemplateJobsOutput, bool) bool) error + ListNodeFromTemplateJobsPagesWithContext(aws.Context, *panorama.ListNodeFromTemplateJobsInput, func(*panorama.ListNodeFromTemplateJobsOutput, bool) bool, ...request.Option) error + + ListNodes(*panorama.ListNodesInput) (*panorama.ListNodesOutput, error) + ListNodesWithContext(aws.Context, *panorama.ListNodesInput, ...request.Option) (*panorama.ListNodesOutput, error) + ListNodesRequest(*panorama.ListNodesInput) (*request.Request, *panorama.ListNodesOutput) + + ListNodesPages(*panorama.ListNodesInput, func(*panorama.ListNodesOutput, bool) bool) error + ListNodesPagesWithContext(aws.Context, *panorama.ListNodesInput, func(*panorama.ListNodesOutput, bool) bool, ...request.Option) error + + ListPackageImportJobs(*panorama.ListPackageImportJobsInput) (*panorama.ListPackageImportJobsOutput, error) + ListPackageImportJobsWithContext(aws.Context, *panorama.ListPackageImportJobsInput, ...request.Option) (*panorama.ListPackageImportJobsOutput, error) + ListPackageImportJobsRequest(*panorama.ListPackageImportJobsInput) (*request.Request, *panorama.ListPackageImportJobsOutput) + + ListPackageImportJobsPages(*panorama.ListPackageImportJobsInput, func(*panorama.ListPackageImportJobsOutput, bool) bool) error + ListPackageImportJobsPagesWithContext(aws.Context, *panorama.ListPackageImportJobsInput, func(*panorama.ListPackageImportJobsOutput, bool) bool, ...request.Option) error + + ListPackages(*panorama.ListPackagesInput) (*panorama.ListPackagesOutput, error) + ListPackagesWithContext(aws.Context, *panorama.ListPackagesInput, ...request.Option) (*panorama.ListPackagesOutput, error) + ListPackagesRequest(*panorama.ListPackagesInput) (*request.Request, *panorama.ListPackagesOutput) + + ListPackagesPages(*panorama.ListPackagesInput, func(*panorama.ListPackagesOutput, bool) bool) error + ListPackagesPagesWithContext(aws.Context, *panorama.ListPackagesInput, func(*panorama.ListPackagesOutput, bool) bool, ...request.Option) error + + ListTagsForResource(*panorama.ListTagsForResourceInput) (*panorama.ListTagsForResourceOutput, error) + ListTagsForResourceWithContext(aws.Context, *panorama.ListTagsForResourceInput, ...request.Option) (*panorama.ListTagsForResourceOutput, error) + ListTagsForResourceRequest(*panorama.ListTagsForResourceInput) (*request.Request, *panorama.ListTagsForResourceOutput) + + ProvisionDevice(*panorama.ProvisionDeviceInput) (*panorama.ProvisionDeviceOutput, error) + ProvisionDeviceWithContext(aws.Context, *panorama.ProvisionDeviceInput, ...request.Option) (*panorama.ProvisionDeviceOutput, error) + ProvisionDeviceRequest(*panorama.ProvisionDeviceInput) (*request.Request, *panorama.ProvisionDeviceOutput) + + RegisterPackageVersion(*panorama.RegisterPackageVersionInput) (*panorama.RegisterPackageVersionOutput, error) + RegisterPackageVersionWithContext(aws.Context, *panorama.RegisterPackageVersionInput, ...request.Option) (*panorama.RegisterPackageVersionOutput, error) + RegisterPackageVersionRequest(*panorama.RegisterPackageVersionInput) (*request.Request, *panorama.RegisterPackageVersionOutput) + + RemoveApplicationInstance(*panorama.RemoveApplicationInstanceInput) (*panorama.RemoveApplicationInstanceOutput, error) + RemoveApplicationInstanceWithContext(aws.Context, *panorama.RemoveApplicationInstanceInput, ...request.Option) (*panorama.RemoveApplicationInstanceOutput, error) + RemoveApplicationInstanceRequest(*panorama.RemoveApplicationInstanceInput) (*request.Request, *panorama.RemoveApplicationInstanceOutput) + + TagResource(*panorama.TagResourceInput) (*panorama.TagResourceOutput, error) + TagResourceWithContext(aws.Context, *panorama.TagResourceInput, ...request.Option) (*panorama.TagResourceOutput, error) + TagResourceRequest(*panorama.TagResourceInput) (*request.Request, *panorama.TagResourceOutput) + + UntagResource(*panorama.UntagResourceInput) (*panorama.UntagResourceOutput, error) + UntagResourceWithContext(aws.Context, *panorama.UntagResourceInput, ...request.Option) (*panorama.UntagResourceOutput, error) + UntagResourceRequest(*panorama.UntagResourceInput) (*request.Request, *panorama.UntagResourceOutput) + + UpdateDeviceMetadata(*panorama.UpdateDeviceMetadataInput) (*panorama.UpdateDeviceMetadataOutput, error) + UpdateDeviceMetadataWithContext(aws.Context, *panorama.UpdateDeviceMetadataInput, ...request.Option) (*panorama.UpdateDeviceMetadataOutput, error) + UpdateDeviceMetadataRequest(*panorama.UpdateDeviceMetadataInput) (*request.Request, *panorama.UpdateDeviceMetadataOutput) +} + +var _ PanoramaAPI = (*panorama.Panorama)(nil) diff --git a/service/panorama/service.go b/service/panorama/service.go new file mode 100644 index 0000000000..73deeb0f39 --- /dev/null +++ b/service/panorama/service.go @@ -0,0 +1,104 @@ +// Code generated by private/model/cli/gen-api/main.go. DO NOT EDIT. + +package panorama + +import ( + "github.com/aws/aws-sdk-go/aws" + "github.com/aws/aws-sdk-go/aws/client" + "github.com/aws/aws-sdk-go/aws/client/metadata" + "github.com/aws/aws-sdk-go/aws/request" + "github.com/aws/aws-sdk-go/aws/signer/v4" + "github.com/aws/aws-sdk-go/private/protocol" + "github.com/aws/aws-sdk-go/private/protocol/restjson" +) + +// Panorama provides the API operation methods for making requests to +// AWS Panorama. See this package's package overview docs +// for details on the service. +// +// Panorama methods are safe to use concurrently. It is not safe to +// modify mutate any of the struct's properties though. +type Panorama struct { + *client.Client +} + +// Used for custom client initialization logic +var initClient func(*client.Client) + +// Used for custom request initialization logic +var initRequest func(*request.Request) + +// Service information constants +const ( + ServiceName = "Panorama" // Name of service. + EndpointsID = "panorama" // ID to lookup a service endpoint with. + ServiceID = "Panorama" // ServiceID is a unique identifier of a specific service. +) + +// New creates a new instance of the Panorama client with a session. +// If additional configuration is needed for the client instance use the optional +// aws.Config parameter to add your extra config. +// +// Example: +// mySession := session.Must(session.NewSession()) +// +// // Create a Panorama client from just a session. +// svc := panorama.New(mySession) +// +// // Create a Panorama client with additional configuration +// svc := panorama.New(mySession, aws.NewConfig().WithRegion("us-west-2")) +func New(p client.ConfigProvider, cfgs ...*aws.Config) *Panorama { + c := p.ClientConfig(EndpointsID, cfgs...) + if c.SigningNameDerived || len(c.SigningName) == 0 { + c.SigningName = "panorama" + } + return newClient(*c.Config, c.Handlers, c.PartitionID, c.Endpoint, c.SigningRegion, c.SigningName) +} + +// newClient creates, initializes and returns a new service client instance. +func newClient(cfg aws.Config, handlers request.Handlers, partitionID, endpoint, signingRegion, signingName string) *Panorama { + svc := &Panorama{ + Client: client.New( + cfg, + metadata.ClientInfo{ + ServiceName: ServiceName, + ServiceID: ServiceID, + SigningName: signingName, + SigningRegion: signingRegion, + PartitionID: partitionID, + Endpoint: endpoint, + APIVersion: "2019-07-24", + }, + handlers, + ), + } + + // Handlers + svc.Handlers.Sign.PushBackNamed(v4.SignRequestHandler) + svc.Handlers.Build.PushBackNamed(restjson.BuildHandler) + svc.Handlers.Unmarshal.PushBackNamed(restjson.UnmarshalHandler) + svc.Handlers.UnmarshalMeta.PushBackNamed(restjson.UnmarshalMetaHandler) + svc.Handlers.UnmarshalError.PushBackNamed( + protocol.NewUnmarshalErrorHandler(restjson.NewUnmarshalTypedError(exceptionFromCode)).NamedHandler(), + ) + + // Run custom client initialization if present + if initClient != nil { + initClient(svc.Client) + } + + return svc +} + +// newRequest creates a new request for a Panorama operation and runs any +// custom request initialization. +func (c *Panorama) newRequest(op *request.Operation, params, data interface{}) *request.Request { + req := c.NewRequest(op, params, data) + + // Run custom request initialization if present + if initRequest != nil { + initRequest(req) + } + + return req +} diff --git a/service/securityhub/api.go b/service/securityhub/api.go index c95a2417a8..07b1b57563 100644 --- a/service/securityhub/api.go +++ b/service/securityhub/api.go @@ -783,6 +783,106 @@ func (c *SecurityHub) CreateActionTargetWithContext(ctx aws.Context, input *Crea return out, req.Send() } +const opCreateFindingAggregator = "CreateFindingAggregator" + +// CreateFindingAggregatorRequest generates a "aws/request.Request" representing the +// client's request for the CreateFindingAggregator operation. The "output" return +// value will be populated with the request's response once the request completes +// successfully. +// +// Use "Send" method on the returned Request to send the API call to the service. +// the "output" return value is not valid until after Send returns without error. +// +// See CreateFindingAggregator for more information on using the CreateFindingAggregator +// API call, and error handling. +// +// This method is useful when you want to inject custom logic or configuration +// into the SDK's request lifecycle. Such as custom headers, or retry logic. +// +// +// // Example sending a request using the CreateFindingAggregatorRequest method. +// req, resp := client.CreateFindingAggregatorRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/securityhub-2018-10-26/CreateFindingAggregator +func (c *SecurityHub) CreateFindingAggregatorRequest(input *CreateFindingAggregatorInput) (req *request.Request, output *CreateFindingAggregatorOutput) { + op := &request.Operation{ + Name: opCreateFindingAggregator, + HTTPMethod: "POST", + HTTPPath: "/findingAggregator/create", + } + + if input == nil { + input = &CreateFindingAggregatorInput{} + } + + output = &CreateFindingAggregatorOutput{} + req = c.newRequest(op, input, output) + return +} + +// CreateFindingAggregator API operation for AWS SecurityHub. +// +// Used to enable finding aggregation. Must be called from the aggregation Region. +// +// For more details about cross-Region replication, see Configuring finding +// aggregation (securityhub/latest/userguide/finding-aggregation.html) in the +// Security Hub User Guide. +// +// Returns awserr.Error for service API and SDK errors. Use runtime type assertions +// with awserr.Error's Code and Message methods to get detailed information about +// the error. +// +// See the AWS API reference guide for AWS SecurityHub's +// API operation CreateFindingAggregator for usage and error information. +// +// Returned Error Types: +// * InternalException +// Internal server error. +// +// * LimitExceededException +// The request was rejected because it attempted to create resources beyond +// the current Amazon Web Services account or throttling limits. The error code +// describes the limit exceeded. +// +// * InvalidAccessException +// There is an issue with the account used to make the request. Either Security +// Hub is not enabled for the account, or the account does not have permission +// to perform this action. +// +// * AccessDeniedException +// You don't have permission to perform the action specified in the request. +// +// * InvalidInputException +// The request was rejected because you supplied an invalid or out-of-range +// value for an input parameter. +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/securityhub-2018-10-26/CreateFindingAggregator +func (c *SecurityHub) CreateFindingAggregator(input *CreateFindingAggregatorInput) (*CreateFindingAggregatorOutput, error) { + req, out := c.CreateFindingAggregatorRequest(input) + return out, req.Send() +} + +// CreateFindingAggregatorWithContext is the same as CreateFindingAggregator with the addition of +// the ability to pass a context and additional request options. +// +// See CreateFindingAggregator for details on how to use this API operation. +// +// The context must be non-nil and will be used for request cancellation. If +// the context is nil a panic will occur. In the future the SDK may create +// sub-contexts for http.Requests. See https://golang.org/pkg/context/ +// for more information on using Contexts. +func (c *SecurityHub) CreateFindingAggregatorWithContext(ctx aws.Context, input *CreateFindingAggregatorInput, opts ...request.Option) (*CreateFindingAggregatorOutput, error) { + req, out := c.CreateFindingAggregatorRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + const opCreateInsight = "CreateInsight" // CreateInsightRequest generates a "aws/request.Request" representing the @@ -1206,6 +1306,111 @@ func (c *SecurityHub) DeleteActionTargetWithContext(ctx aws.Context, input *Dele return out, req.Send() } +const opDeleteFindingAggregator = "DeleteFindingAggregator" + +// DeleteFindingAggregatorRequest generates a "aws/request.Request" representing the +// client's request for the DeleteFindingAggregator operation. The "output" return +// value will be populated with the request's response once the request completes +// successfully. +// +// Use "Send" method on the returned Request to send the API call to the service. +// the "output" return value is not valid until after Send returns without error. +// +// See DeleteFindingAggregator for more information on using the DeleteFindingAggregator +// API call, and error handling. +// +// This method is useful when you want to inject custom logic or configuration +// into the SDK's request lifecycle. Such as custom headers, or retry logic. +// +// +// // Example sending a request using the DeleteFindingAggregatorRequest method. +// req, resp := client.DeleteFindingAggregatorRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/securityhub-2018-10-26/DeleteFindingAggregator +func (c *SecurityHub) DeleteFindingAggregatorRequest(input *DeleteFindingAggregatorInput) (req *request.Request, output *DeleteFindingAggregatorOutput) { + op := &request.Operation{ + Name: opDeleteFindingAggregator, + HTTPMethod: "DELETE", + HTTPPath: "/findingAggregator/delete/{FindingAggregatorArn+}", + } + + if input == nil { + input = &DeleteFindingAggregatorInput{} + } + + output = &DeleteFindingAggregatorOutput{} + req = c.newRequest(op, input, output) + req.Handlers.Unmarshal.Swap(restjson.UnmarshalHandler.Name, protocol.UnmarshalDiscardBodyHandler) + return +} + +// DeleteFindingAggregator API operation for AWS SecurityHub. +// +// Deletes a finding aggregator. When you delete the finding aggregator, you +// stop finding aggregation. +// +// When you stop finding aggregation, findings that were already aggregated +// to the aggregation Region are still visible from the aggregation Region. +// New findings and finding updates are not aggregated. +// +// Returns awserr.Error for service API and SDK errors. Use runtime type assertions +// with awserr.Error's Code and Message methods to get detailed information about +// the error. +// +// See the AWS API reference guide for AWS SecurityHub's +// API operation DeleteFindingAggregator for usage and error information. +// +// Returned Error Types: +// * InternalException +// Internal server error. +// +// * LimitExceededException +// The request was rejected because it attempted to create resources beyond +// the current Amazon Web Services account or throttling limits. The error code +// describes the limit exceeded. +// +// * InvalidAccessException +// There is an issue with the account used to make the request. Either Security +// Hub is not enabled for the account, or the account does not have permission +// to perform this action. +// +// * AccessDeniedException +// You don't have permission to perform the action specified in the request. +// +// * InvalidInputException +// The request was rejected because you supplied an invalid or out-of-range +// value for an input parameter. +// +// * ResourceNotFoundException +// The request was rejected because we can't find the specified resource. +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/securityhub-2018-10-26/DeleteFindingAggregator +func (c *SecurityHub) DeleteFindingAggregator(input *DeleteFindingAggregatorInput) (*DeleteFindingAggregatorOutput, error) { + req, out := c.DeleteFindingAggregatorRequest(input) + return out, req.Send() +} + +// DeleteFindingAggregatorWithContext is the same as DeleteFindingAggregator with the addition of +// the ability to pass a context and additional request options. +// +// See DeleteFindingAggregator for details on how to use this API operation. +// +// The context must be non-nil and will be used for request cancellation. If +// the context is nil a panic will occur. In the future the SDK may create +// sub-contexts for http.Requests. See https://golang.org/pkg/context/ +// for more information on using Contexts. +func (c *SecurityHub) DeleteFindingAggregatorWithContext(ctx aws.Context, input *DeleteFindingAggregatorInput, opts ...request.Option) (*DeleteFindingAggregatorOutput, error) { + req, out := c.DeleteFindingAggregatorRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + const opDeleteInsight = "DeleteInsight" // DeleteInsightRequest generates a "aws/request.Request" representing the @@ -3488,6 +3693,105 @@ func (c *SecurityHub) GetEnabledStandardsPagesWithContext(ctx aws.Context, input return p.Err() } +const opGetFindingAggregator = "GetFindingAggregator" + +// GetFindingAggregatorRequest generates a "aws/request.Request" representing the +// client's request for the GetFindingAggregator operation. The "output" return +// value will be populated with the request's response once the request completes +// successfully. +// +// Use "Send" method on the returned Request to send the API call to the service. +// the "output" return value is not valid until after Send returns without error. +// +// See GetFindingAggregator for more information on using the GetFindingAggregator +// API call, and error handling. +// +// This method is useful when you want to inject custom logic or configuration +// into the SDK's request lifecycle. Such as custom headers, or retry logic. +// +// +// // Example sending a request using the GetFindingAggregatorRequest method. +// req, resp := client.GetFindingAggregatorRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/securityhub-2018-10-26/GetFindingAggregator +func (c *SecurityHub) GetFindingAggregatorRequest(input *GetFindingAggregatorInput) (req *request.Request, output *GetFindingAggregatorOutput) { + op := &request.Operation{ + Name: opGetFindingAggregator, + HTTPMethod: "GET", + HTTPPath: "/findingAggregator/get/{FindingAggregatorArn+}", + } + + if input == nil { + input = &GetFindingAggregatorInput{} + } + + output = &GetFindingAggregatorOutput{} + req = c.newRequest(op, input, output) + return +} + +// GetFindingAggregator API operation for AWS SecurityHub. +// +// Returns the current finding aggregation configuration. +// +// Returns awserr.Error for service API and SDK errors. Use runtime type assertions +// with awserr.Error's Code and Message methods to get detailed information about +// the error. +// +// See the AWS API reference guide for AWS SecurityHub's +// API operation GetFindingAggregator for usage and error information. +// +// Returned Error Types: +// * InternalException +// Internal server error. +// +// * LimitExceededException +// The request was rejected because it attempted to create resources beyond +// the current Amazon Web Services account or throttling limits. The error code +// describes the limit exceeded. +// +// * InvalidAccessException +// There is an issue with the account used to make the request. Either Security +// Hub is not enabled for the account, or the account does not have permission +// to perform this action. +// +// * AccessDeniedException +// You don't have permission to perform the action specified in the request. +// +// * InvalidInputException +// The request was rejected because you supplied an invalid or out-of-range +// value for an input parameter. +// +// * ResourceNotFoundException +// The request was rejected because we can't find the specified resource. +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/securityhub-2018-10-26/GetFindingAggregator +func (c *SecurityHub) GetFindingAggregator(input *GetFindingAggregatorInput) (*GetFindingAggregatorOutput, error) { + req, out := c.GetFindingAggregatorRequest(input) + return out, req.Send() +} + +// GetFindingAggregatorWithContext is the same as GetFindingAggregator with the addition of +// the ability to pass a context and additional request options. +// +// See GetFindingAggregator for details on how to use this API operation. +// +// The context must be non-nil and will be used for request cancellation. If +// the context is nil a panic will occur. In the future the SDK may create +// sub-contexts for http.Requests. See https://golang.org/pkg/context/ +// for more information on using Contexts. +func (c *SecurityHub) GetFindingAggregatorWithContext(ctx aws.Context, input *GetFindingAggregatorInput, opts ...request.Option) (*GetFindingAggregatorOutput, error) { + req, out := c.GetFindingAggregatorRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + const opGetFindings = "GetFindings" // GetFindingsRequest generates a "aws/request.Request" representing the @@ -3540,6 +3844,10 @@ func (c *SecurityHub) GetFindingsRequest(input *GetFindingsInput) (req *request. // // Returns a list of findings that match the specified criteria. // +// If finding aggregation is enabled, then when you call GetFindings from the +// aggregation Region, the results include all of the matching findings from +// both the aggregation Region and the linked Regions. +// // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about // the error. @@ -4459,6 +4767,161 @@ func (c *SecurityHub) ListEnabledProductsForImportPagesWithContext(ctx aws.Conte return p.Err() } +const opListFindingAggregators = "ListFindingAggregators" + +// ListFindingAggregatorsRequest generates a "aws/request.Request" representing the +// client's request for the ListFindingAggregators operation. The "output" return +// value will be populated with the request's response once the request completes +// successfully. +// +// Use "Send" method on the returned Request to send the API call to the service. +// the "output" return value is not valid until after Send returns without error. +// +// See ListFindingAggregators for more information on using the ListFindingAggregators +// API call, and error handling. +// +// This method is useful when you want to inject custom logic or configuration +// into the SDK's request lifecycle. Such as custom headers, or retry logic. +// +// +// // Example sending a request using the ListFindingAggregatorsRequest method. +// req, resp := client.ListFindingAggregatorsRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/securityhub-2018-10-26/ListFindingAggregators +func (c *SecurityHub) ListFindingAggregatorsRequest(input *ListFindingAggregatorsInput) (req *request.Request, output *ListFindingAggregatorsOutput) { + op := &request.Operation{ + Name: opListFindingAggregators, + HTTPMethod: "GET", + HTTPPath: "/findingAggregator/list", + Paginator: &request.Paginator{ + InputTokens: []string{"NextToken"}, + OutputTokens: []string{"NextToken"}, + LimitToken: "MaxResults", + TruncationToken: "", + }, + } + + if input == nil { + input = &ListFindingAggregatorsInput{} + } + + output = &ListFindingAggregatorsOutput{} + req = c.newRequest(op, input, output) + return +} + +// ListFindingAggregators API operation for AWS SecurityHub. +// +// If finding aggregation is enabled, then ListFindingAggregators returns the +// ARN of the finding aggregator. You can run this operation from any Region. +// +// Returns awserr.Error for service API and SDK errors. Use runtime type assertions +// with awserr.Error's Code and Message methods to get detailed information about +// the error. +// +// See the AWS API reference guide for AWS SecurityHub's +// API operation ListFindingAggregators for usage and error information. +// +// Returned Error Types: +// * InternalException +// Internal server error. +// +// * LimitExceededException +// The request was rejected because it attempted to create resources beyond +// the current Amazon Web Services account or throttling limits. The error code +// describes the limit exceeded. +// +// * InvalidAccessException +// There is an issue with the account used to make the request. Either Security +// Hub is not enabled for the account, or the account does not have permission +// to perform this action. +// +// * AccessDeniedException +// You don't have permission to perform the action specified in the request. +// +// * InvalidInputException +// The request was rejected because you supplied an invalid or out-of-range +// value for an input parameter. +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/securityhub-2018-10-26/ListFindingAggregators +func (c *SecurityHub) ListFindingAggregators(input *ListFindingAggregatorsInput) (*ListFindingAggregatorsOutput, error) { + req, out := c.ListFindingAggregatorsRequest(input) + return out, req.Send() +} + +// ListFindingAggregatorsWithContext is the same as ListFindingAggregators with the addition of +// the ability to pass a context and additional request options. +// +// See ListFindingAggregators for details on how to use this API operation. +// +// The context must be non-nil and will be used for request cancellation. If +// the context is nil a panic will occur. In the future the SDK may create +// sub-contexts for http.Requests. See https://golang.org/pkg/context/ +// for more information on using Contexts. +func (c *SecurityHub) ListFindingAggregatorsWithContext(ctx aws.Context, input *ListFindingAggregatorsInput, opts ...request.Option) (*ListFindingAggregatorsOutput, error) { + req, out := c.ListFindingAggregatorsRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + +// ListFindingAggregatorsPages iterates over the pages of a ListFindingAggregators operation, +// calling the "fn" function with the response data for each page. To stop +// iterating, return false from the fn function. +// +// See ListFindingAggregators method for more information on how to use this operation. +// +// Note: This operation can generate multiple requests to a service. +// +// // Example iterating over at most 3 pages of a ListFindingAggregators operation. +// pageNum := 0 +// err := client.ListFindingAggregatorsPages(params, +// func(page *securityhub.ListFindingAggregatorsOutput, lastPage bool) bool { +// pageNum++ +// fmt.Println(page) +// return pageNum <= 3 +// }) +// +func (c *SecurityHub) ListFindingAggregatorsPages(input *ListFindingAggregatorsInput, fn func(*ListFindingAggregatorsOutput, bool) bool) error { + return c.ListFindingAggregatorsPagesWithContext(aws.BackgroundContext(), input, fn) +} + +// ListFindingAggregatorsPagesWithContext same as ListFindingAggregatorsPages except +// it takes a Context and allows setting request options on the pages. +// +// The context must be non-nil and will be used for request cancellation. If +// the context is nil a panic will occur. In the future the SDK may create +// sub-contexts for http.Requests. See https://golang.org/pkg/context/ +// for more information on using Contexts. +func (c *SecurityHub) ListFindingAggregatorsPagesWithContext(ctx aws.Context, input *ListFindingAggregatorsInput, fn func(*ListFindingAggregatorsOutput, bool) bool, opts ...request.Option) error { + p := request.Pagination{ + NewRequest: func() (*request.Request, error) { + var inCpy *ListFindingAggregatorsInput + if input != nil { + tmp := *input + inCpy = &tmp + } + req, _ := c.ListFindingAggregatorsRequest(inCpy) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return req, nil + }, + } + + for p.Next() { + if !fn(p.Page().(*ListFindingAggregatorsOutput), !p.HasNextPage()) { + break + } + } + + return p.Err() +} + const opListInvitations = "ListInvitations" // ListInvitationsRequest generates a "aws/request.Request" representing the @@ -5277,6 +5740,109 @@ func (c *SecurityHub) UpdateActionTargetWithContext(ctx aws.Context, input *Upda return out, req.Send() } +const opUpdateFindingAggregator = "UpdateFindingAggregator" + +// UpdateFindingAggregatorRequest generates a "aws/request.Request" representing the +// client's request for the UpdateFindingAggregator operation. The "output" return +// value will be populated with the request's response once the request completes +// successfully. +// +// Use "Send" method on the returned Request to send the API call to the service. +// the "output" return value is not valid until after Send returns without error. +// +// See UpdateFindingAggregator for more information on using the UpdateFindingAggregator +// API call, and error handling. +// +// This method is useful when you want to inject custom logic or configuration +// into the SDK's request lifecycle. Such as custom headers, or retry logic. +// +// +// // Example sending a request using the UpdateFindingAggregatorRequest method. +// req, resp := client.UpdateFindingAggregatorRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/securityhub-2018-10-26/UpdateFindingAggregator +func (c *SecurityHub) UpdateFindingAggregatorRequest(input *UpdateFindingAggregatorInput) (req *request.Request, output *UpdateFindingAggregatorOutput) { + op := &request.Operation{ + Name: opUpdateFindingAggregator, + HTTPMethod: "PATCH", + HTTPPath: "/findingAggregator/update", + } + + if input == nil { + input = &UpdateFindingAggregatorInput{} + } + + output = &UpdateFindingAggregatorOutput{} + req = c.newRequest(op, input, output) + return +} + +// UpdateFindingAggregator API operation for AWS SecurityHub. +// +// Updates the finding aggregation configuration. Used to update the Region +// linking mode and the list of included or excluded Regions. You cannot use +// UpdateFindingAggregator to change the aggregation Region. +// +// You must run UpdateFindingAggregator from the current aggregation Region. +// +// Returns awserr.Error for service API and SDK errors. Use runtime type assertions +// with awserr.Error's Code and Message methods to get detailed information about +// the error. +// +// See the AWS API reference guide for AWS SecurityHub's +// API operation UpdateFindingAggregator for usage and error information. +// +// Returned Error Types: +// * InternalException +// Internal server error. +// +// * LimitExceededException +// The request was rejected because it attempted to create resources beyond +// the current Amazon Web Services account or throttling limits. The error code +// describes the limit exceeded. +// +// * InvalidAccessException +// There is an issue with the account used to make the request. Either Security +// Hub is not enabled for the account, or the account does not have permission +// to perform this action. +// +// * AccessDeniedException +// You don't have permission to perform the action specified in the request. +// +// * InvalidInputException +// The request was rejected because you supplied an invalid or out-of-range +// value for an input parameter. +// +// * ResourceNotFoundException +// The request was rejected because we can't find the specified resource. +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/securityhub-2018-10-26/UpdateFindingAggregator +func (c *SecurityHub) UpdateFindingAggregator(input *UpdateFindingAggregatorInput) (*UpdateFindingAggregatorOutput, error) { + req, out := c.UpdateFindingAggregatorRequest(input) + return out, req.Send() +} + +// UpdateFindingAggregatorWithContext is the same as UpdateFindingAggregator with the addition of +// the ability to pass a context and additional request options. +// +// See UpdateFindingAggregator for details on how to use this API operation. +// +// The context must be non-nil and will be used for request cancellation. If +// the context is nil a panic will occur. In the future the SDK may create +// sub-contexts for http.Requests. See https://golang.org/pkg/context/ +// for more information on using Contexts. +func (c *SecurityHub) UpdateFindingAggregatorWithContext(ctx aws.Context, input *UpdateFindingAggregatorInput, opts ...request.Option) (*UpdateFindingAggregatorOutput, error) { + req, out := c.UpdateFindingAggregatorRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + const opUpdateFindings = "UpdateFindings" // UpdateFindingsRequest generates a "aws/request.Request" representing the @@ -30374,6 +30940,148 @@ func (s *CreateActionTargetOutput) SetActionTargetArn(v string) *CreateActionTar return s } +type CreateFindingAggregatorInput struct { + _ struct{} `type:"structure"` + + // Indicates whether to aggregate findings from all of the available Regions + // in the current partition. Also determines whether to automatically aggregate + // findings from new Regions as Security Hub supports them and you opt into + // them. + // + // The selected option also determines how to use the Regions provided in the + // Regions list. + // + // The options are as follows: + // + // * ALL_REGIONS - Indicates to aggregate findings from all of the Regions + // where Security Hub is enabled. When you choose this option, Security Hub + // also automatically aggregates findings from new Regions as Security Hub + // supports them and you opt into them. + // + // * ALL_REGIONS_EXCEPT_SPECIFIED - Indicates to aggregate findings from + // all of the Regions where Security Hub is enabled, except for the Regions + // listed in the Regions parameter. When you choose this option, Security + // Hub also automatically aggregates findings from new Regions as Security + // Hub supports them and you opt into them. + // + // * SPECIFIED_REGIONS - Indicates to aggregate findings only from the Regions + // listed in the Regions parameter. Security Hub does not automatically aggregate + // findings from new Regions. + // + // RegionLinkingMode is a required field + RegionLinkingMode *string `type:"string" required:"true"` + + // If RegionLinkingMode is ALL_REGIONS_EXCEPT_SPECIFIED, then this is a comma-separated + // list of Regions that do not aggregate findings to the aggregation Region. + // + // If RegionLinkingMode is SPECIFIED_REGIONS, then this is a comma-separated + // list of Regions that do aggregate findings to the aggregation Region. + Regions []*string `type:"list"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s CreateFindingAggregatorInput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s CreateFindingAggregatorInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *CreateFindingAggregatorInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "CreateFindingAggregatorInput"} + if s.RegionLinkingMode == nil { + invalidParams.Add(request.NewErrParamRequired("RegionLinkingMode")) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetRegionLinkingMode sets the RegionLinkingMode field's value. +func (s *CreateFindingAggregatorInput) SetRegionLinkingMode(v string) *CreateFindingAggregatorInput { + s.RegionLinkingMode = &v + return s +} + +// SetRegions sets the Regions field's value. +func (s *CreateFindingAggregatorInput) SetRegions(v []*string) *CreateFindingAggregatorInput { + s.Regions = v + return s +} + +type CreateFindingAggregatorOutput struct { + _ struct{} `type:"structure"` + + // The aggregation Region. + FindingAggregationRegion *string `type:"string"` + + // The ARN of the finding aggregator. You use the finding aggregator ARN to + // retrieve details for, update, and stop finding aggregation. + FindingAggregatorArn *string `type:"string"` + + // Indicates whether to link all Regions, all Regions except for a list of excluded + // Regions, or a list of included Regions. + RegionLinkingMode *string `type:"string"` + + // The list of excluded Regions or included Regions. + Regions []*string `type:"list"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s CreateFindingAggregatorOutput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s CreateFindingAggregatorOutput) GoString() string { + return s.String() +} + +// SetFindingAggregationRegion sets the FindingAggregationRegion field's value. +func (s *CreateFindingAggregatorOutput) SetFindingAggregationRegion(v string) *CreateFindingAggregatorOutput { + s.FindingAggregationRegion = &v + return s +} + +// SetFindingAggregatorArn sets the FindingAggregatorArn field's value. +func (s *CreateFindingAggregatorOutput) SetFindingAggregatorArn(v string) *CreateFindingAggregatorOutput { + s.FindingAggregatorArn = &v + return s +} + +// SetRegionLinkingMode sets the RegionLinkingMode field's value. +func (s *CreateFindingAggregatorOutput) SetRegionLinkingMode(v string) *CreateFindingAggregatorOutput { + s.RegionLinkingMode = &v + return s +} + +// SetRegions sets the Regions field's value. +func (s *CreateFindingAggregatorOutput) SetRegions(v []*string) *CreateFindingAggregatorOutput { + s.Regions = v + return s +} + type CreateInsightInput struct { _ struct{} `type:"structure"` @@ -31038,6 +31746,77 @@ func (s *DeleteActionTargetOutput) SetActionTargetArn(v string) *DeleteActionTar return s } +type DeleteFindingAggregatorInput struct { + _ struct{} `type:"structure" nopayload:"true"` + + // The ARN of the finding aggregator to delete. To obtain the ARN, use ListFindingAggregators. + // + // FindingAggregatorArn is a required field + FindingAggregatorArn *string `location:"uri" locationName:"FindingAggregatorArn" type:"string" required:"true"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s DeleteFindingAggregatorInput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s DeleteFindingAggregatorInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *DeleteFindingAggregatorInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "DeleteFindingAggregatorInput"} + if s.FindingAggregatorArn == nil { + invalidParams.Add(request.NewErrParamRequired("FindingAggregatorArn")) + } + if s.FindingAggregatorArn != nil && len(*s.FindingAggregatorArn) < 1 { + invalidParams.Add(request.NewErrParamMinLen("FindingAggregatorArn", 1)) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetFindingAggregatorArn sets the FindingAggregatorArn field's value. +func (s *DeleteFindingAggregatorInput) SetFindingAggregatorArn(v string) *DeleteFindingAggregatorInput { + s.FindingAggregatorArn = &v + return s +} + +type DeleteFindingAggregatorOutput struct { + _ struct{} `type:"structure"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s DeleteFindingAggregatorOutput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s DeleteFindingAggregatorOutput) GoString() string { + return s.String() +} + type DeleteInsightInput struct { _ struct{} `type:"structure" nopayload:"true"` @@ -32473,6 +33252,40 @@ func (s EnableSecurityHubOutput) GoString() string { return s.String() } +// A finding aggregator. A finding aggregator contains the configuration for +// finding aggregation. +type FindingAggregator struct { + _ struct{} `type:"structure"` + + // The ARN of the finding aggregator. You use the finding aggregator ARN to + // retrieve details for, update, and delete the finding aggregator. + FindingAggregatorArn *string `type:"string"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s FindingAggregator) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s FindingAggregator) GoString() string { + return s.String() +} + +// SetFindingAggregatorArn sets the FindingAggregatorArn field's value. +func (s *FindingAggregator) SetFindingAggregatorArn(v string) *FindingAggregator { + s.FindingAggregatorArn = &v + return s +} + // In a BatchImportFindings request, finding providers use FindingProviderFields // to provide and update values for confidence, criticality, related findings, // severity, and types. @@ -32819,6 +33632,115 @@ func (s *GetEnabledStandardsOutput) SetStandardsSubscriptions(v []*StandardsSubs return s } +type GetFindingAggregatorInput struct { + _ struct{} `type:"structure" nopayload:"true"` + + // The ARN of the finding aggregator to return details for. To obtain the ARN, + // use ListFindingAggregators. + // + // FindingAggregatorArn is a required field + FindingAggregatorArn *string `location:"uri" locationName:"FindingAggregatorArn" type:"string" required:"true"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s GetFindingAggregatorInput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s GetFindingAggregatorInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *GetFindingAggregatorInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "GetFindingAggregatorInput"} + if s.FindingAggregatorArn == nil { + invalidParams.Add(request.NewErrParamRequired("FindingAggregatorArn")) + } + if s.FindingAggregatorArn != nil && len(*s.FindingAggregatorArn) < 1 { + invalidParams.Add(request.NewErrParamMinLen("FindingAggregatorArn", 1)) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetFindingAggregatorArn sets the FindingAggregatorArn field's value. +func (s *GetFindingAggregatorInput) SetFindingAggregatorArn(v string) *GetFindingAggregatorInput { + s.FindingAggregatorArn = &v + return s +} + +type GetFindingAggregatorOutput struct { + _ struct{} `type:"structure"` + + // The aggregation Region. + FindingAggregationRegion *string `type:"string"` + + // The ARN of the finding aggregator. + FindingAggregatorArn *string `type:"string"` + + // Indicates whether to link all Regions, all Regions except for a list of excluded + // Regions, or a list of included Regions. + RegionLinkingMode *string `type:"string"` + + // The list of excluded Regions or included Regions. + Regions []*string `type:"list"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s GetFindingAggregatorOutput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s GetFindingAggregatorOutput) GoString() string { + return s.String() +} + +// SetFindingAggregationRegion sets the FindingAggregationRegion field's value. +func (s *GetFindingAggregatorOutput) SetFindingAggregationRegion(v string) *GetFindingAggregatorOutput { + s.FindingAggregationRegion = &v + return s +} + +// SetFindingAggregatorArn sets the FindingAggregatorArn field's value. +func (s *GetFindingAggregatorOutput) SetFindingAggregatorArn(v string) *GetFindingAggregatorOutput { + s.FindingAggregatorArn = &v + return s +} + +// SetRegionLinkingMode sets the RegionLinkingMode field's value. +func (s *GetFindingAggregatorOutput) SetRegionLinkingMode(v string) *GetFindingAggregatorOutput { + s.RegionLinkingMode = &v + return s +} + +// SetRegions sets the Regions field's value. +func (s *GetFindingAggregatorOutput) SetRegions(v []*string) *GetFindingAggregatorOutput { + s.Regions = v + return s +} + type GetFindingsInput struct { _ struct{} `type:"structure"` @@ -34286,6 +35208,105 @@ func (s *ListEnabledProductsForImportOutput) SetProductSubscriptions(v []*string return s } +type ListFindingAggregatorsInput struct { + _ struct{} `type:"structure" nopayload:"true"` + + // The maximum number of results to return. This operation currently only returns + // a single result. + MaxResults *int64 `location:"querystring" locationName:"MaxResults" min:"1" type:"integer"` + + // The token returned with the previous set of results. Identifies the next + // set of results to return. + NextToken *string `location:"querystring" locationName:"NextToken" type:"string"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ListFindingAggregatorsInput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ListFindingAggregatorsInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *ListFindingAggregatorsInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "ListFindingAggregatorsInput"} + if s.MaxResults != nil && *s.MaxResults < 1 { + invalidParams.Add(request.NewErrParamMinValue("MaxResults", 1)) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetMaxResults sets the MaxResults field's value. +func (s *ListFindingAggregatorsInput) SetMaxResults(v int64) *ListFindingAggregatorsInput { + s.MaxResults = &v + return s +} + +// SetNextToken sets the NextToken field's value. +func (s *ListFindingAggregatorsInput) SetNextToken(v string) *ListFindingAggregatorsInput { + s.NextToken = &v + return s +} + +type ListFindingAggregatorsOutput struct { + _ struct{} `type:"structure"` + + // The list of finding aggregators. This operation currently only returns a + // single result. + FindingAggregators []*FindingAggregator `type:"list"` + + // If there are more results, this is the token to provide in the next call + // to ListFindingAggregators. + // + // This operation currently only returns a single result. + NextToken *string `type:"string"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ListFindingAggregatorsOutput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ListFindingAggregatorsOutput) GoString() string { + return s.String() +} + +// SetFindingAggregators sets the FindingAggregators field's value. +func (s *ListFindingAggregatorsOutput) SetFindingAggregators(v []*FindingAggregator) *ListFindingAggregatorsOutput { + s.FindingAggregators = v + return s +} + +// SetNextToken sets the NextToken field's value. +func (s *ListFindingAggregatorsOutput) SetNextToken(v string) *ListFindingAggregatorsOutput { + s.NextToken = &v + return s +} + type ListInvitationsInput struct { _ struct{} `type:"structure" nopayload:"true"` @@ -38567,6 +39588,161 @@ func (s UpdateActionTargetOutput) GoString() string { return s.String() } +type UpdateFindingAggregatorInput struct { + _ struct{} `type:"structure"` + + // The ARN of the finding aggregator. To obtain the ARN, use ListFindingAggregators. + // + // FindingAggregatorArn is a required field + FindingAggregatorArn *string `type:"string" required:"true"` + + // Indicates whether to aggregate findings from all of the available Regions + // in the current partition. Also determines whether to automatically aggregate + // findings from new Regions as Security Hub supports them and you opt into + // them. + // + // The selected option also determines how to use the Regions provided in the + // Regions list. + // + // The options are as follows: + // + // * ALL_REGIONS - Indicates to aggregate findings from all of the Regions + // where Security Hub is enabled. When you choose this option, Security Hub + // also automatically aggregates findings from new Regions as Security Hub + // supports them and you opt into them. + // + // * ALL_REGIONS_EXCEPT_SPECIFIED - Indicates to aggregate findings from + // all of the Regions where Security Hub is enabled, except for the Regions + // listed in the Regions parameter. When you choose this option, Security + // Hub also automatically aggregates findings from new Regions as Security + // Hub supports them and you opt into them. + // + // * SPECIFIED_REGIONS - Indicates to aggregate findings only from the Regions + // listed in the Regions parameter. Security Hub does not automatically aggregate + // findings from new Regions. + // + // RegionLinkingMode is a required field + RegionLinkingMode *string `type:"string" required:"true"` + + // If RegionLinkingMode is ALL_REGIONS_EXCEPT_SPECIFIED, then this is a comma-separated + // list of Regions that do not aggregate findings to the aggregation Region. + // + // If RegionLinkingMode is SPECIFIED_REGIONS, then this is a comma-separated + // list of Regions that do aggregate findings to the aggregation Region. + Regions []*string `type:"list"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s UpdateFindingAggregatorInput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s UpdateFindingAggregatorInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *UpdateFindingAggregatorInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "UpdateFindingAggregatorInput"} + if s.FindingAggregatorArn == nil { + invalidParams.Add(request.NewErrParamRequired("FindingAggregatorArn")) + } + if s.RegionLinkingMode == nil { + invalidParams.Add(request.NewErrParamRequired("RegionLinkingMode")) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetFindingAggregatorArn sets the FindingAggregatorArn field's value. +func (s *UpdateFindingAggregatorInput) SetFindingAggregatorArn(v string) *UpdateFindingAggregatorInput { + s.FindingAggregatorArn = &v + return s +} + +// SetRegionLinkingMode sets the RegionLinkingMode field's value. +func (s *UpdateFindingAggregatorInput) SetRegionLinkingMode(v string) *UpdateFindingAggregatorInput { + s.RegionLinkingMode = &v + return s +} + +// SetRegions sets the Regions field's value. +func (s *UpdateFindingAggregatorInput) SetRegions(v []*string) *UpdateFindingAggregatorInput { + s.Regions = v + return s +} + +type UpdateFindingAggregatorOutput struct { + _ struct{} `type:"structure"` + + // The aggregation Region. + FindingAggregationRegion *string `type:"string"` + + // The ARN of the finding aggregator. + FindingAggregatorArn *string `type:"string"` + + // Indicates whether to link all Regions, all Regions except for a list of excluded + // Regions, or a list of included Regions. + RegionLinkingMode *string `type:"string"` + + // The list of excluded Regions or included Regions. + Regions []*string `type:"list"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s UpdateFindingAggregatorOutput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s UpdateFindingAggregatorOutput) GoString() string { + return s.String() +} + +// SetFindingAggregationRegion sets the FindingAggregationRegion field's value. +func (s *UpdateFindingAggregatorOutput) SetFindingAggregationRegion(v string) *UpdateFindingAggregatorOutput { + s.FindingAggregationRegion = &v + return s +} + +// SetFindingAggregatorArn sets the FindingAggregatorArn field's value. +func (s *UpdateFindingAggregatorOutput) SetFindingAggregatorArn(v string) *UpdateFindingAggregatorOutput { + s.FindingAggregatorArn = &v + return s +} + +// SetRegionLinkingMode sets the RegionLinkingMode field's value. +func (s *UpdateFindingAggregatorOutput) SetRegionLinkingMode(v string) *UpdateFindingAggregatorOutput { + s.RegionLinkingMode = &v + return s +} + +// SetRegions sets the Regions field's value. +func (s *UpdateFindingAggregatorOutput) SetRegions(v []*string) *UpdateFindingAggregatorOutput { + s.Regions = v + return s +} + type UpdateFindingsInput struct { _ struct{} `type:"structure"` diff --git a/service/securityhub/securityhubiface/interface.go b/service/securityhub/securityhubiface/interface.go index 801b15fea4..549e4d9cfe 100644 --- a/service/securityhub/securityhubiface/interface.go +++ b/service/securityhub/securityhubiface/interface.go @@ -88,6 +88,10 @@ type SecurityHubAPI interface { CreateActionTargetWithContext(aws.Context, *securityhub.CreateActionTargetInput, ...request.Option) (*securityhub.CreateActionTargetOutput, error) CreateActionTargetRequest(*securityhub.CreateActionTargetInput) (*request.Request, *securityhub.CreateActionTargetOutput) + CreateFindingAggregator(*securityhub.CreateFindingAggregatorInput) (*securityhub.CreateFindingAggregatorOutput, error) + CreateFindingAggregatorWithContext(aws.Context, *securityhub.CreateFindingAggregatorInput, ...request.Option) (*securityhub.CreateFindingAggregatorOutput, error) + CreateFindingAggregatorRequest(*securityhub.CreateFindingAggregatorInput) (*request.Request, *securityhub.CreateFindingAggregatorOutput) + CreateInsight(*securityhub.CreateInsightInput) (*securityhub.CreateInsightOutput, error) CreateInsightWithContext(aws.Context, *securityhub.CreateInsightInput, ...request.Option) (*securityhub.CreateInsightOutput, error) CreateInsightRequest(*securityhub.CreateInsightInput) (*request.Request, *securityhub.CreateInsightOutput) @@ -104,6 +108,10 @@ type SecurityHubAPI interface { DeleteActionTargetWithContext(aws.Context, *securityhub.DeleteActionTargetInput, ...request.Option) (*securityhub.DeleteActionTargetOutput, error) DeleteActionTargetRequest(*securityhub.DeleteActionTargetInput) (*request.Request, *securityhub.DeleteActionTargetOutput) + DeleteFindingAggregator(*securityhub.DeleteFindingAggregatorInput) (*securityhub.DeleteFindingAggregatorOutput, error) + DeleteFindingAggregatorWithContext(aws.Context, *securityhub.DeleteFindingAggregatorInput, ...request.Option) (*securityhub.DeleteFindingAggregatorOutput, error) + DeleteFindingAggregatorRequest(*securityhub.DeleteFindingAggregatorInput) (*request.Request, *securityhub.DeleteFindingAggregatorOutput) + DeleteInsight(*securityhub.DeleteInsightInput) (*securityhub.DeleteInsightOutput, error) DeleteInsightWithContext(aws.Context, *securityhub.DeleteInsightInput, ...request.Option) (*securityhub.DeleteInsightOutput, error) DeleteInsightRequest(*securityhub.DeleteInsightInput) (*request.Request, *securityhub.DeleteInsightOutput) @@ -199,6 +207,10 @@ type SecurityHubAPI interface { GetEnabledStandardsPages(*securityhub.GetEnabledStandardsInput, func(*securityhub.GetEnabledStandardsOutput, bool) bool) error GetEnabledStandardsPagesWithContext(aws.Context, *securityhub.GetEnabledStandardsInput, func(*securityhub.GetEnabledStandardsOutput, bool) bool, ...request.Option) error + GetFindingAggregator(*securityhub.GetFindingAggregatorInput) (*securityhub.GetFindingAggregatorOutput, error) + GetFindingAggregatorWithContext(aws.Context, *securityhub.GetFindingAggregatorInput, ...request.Option) (*securityhub.GetFindingAggregatorOutput, error) + GetFindingAggregatorRequest(*securityhub.GetFindingAggregatorInput) (*request.Request, *securityhub.GetFindingAggregatorOutput) + GetFindings(*securityhub.GetFindingsInput) (*securityhub.GetFindingsOutput, error) GetFindingsWithContext(aws.Context, *securityhub.GetFindingsInput, ...request.Option) (*securityhub.GetFindingsOutput, error) GetFindingsRequest(*securityhub.GetFindingsInput) (*request.Request, *securityhub.GetFindingsOutput) @@ -240,6 +252,13 @@ type SecurityHubAPI interface { ListEnabledProductsForImportPages(*securityhub.ListEnabledProductsForImportInput, func(*securityhub.ListEnabledProductsForImportOutput, bool) bool) error ListEnabledProductsForImportPagesWithContext(aws.Context, *securityhub.ListEnabledProductsForImportInput, func(*securityhub.ListEnabledProductsForImportOutput, bool) bool, ...request.Option) error + ListFindingAggregators(*securityhub.ListFindingAggregatorsInput) (*securityhub.ListFindingAggregatorsOutput, error) + ListFindingAggregatorsWithContext(aws.Context, *securityhub.ListFindingAggregatorsInput, ...request.Option) (*securityhub.ListFindingAggregatorsOutput, error) + ListFindingAggregatorsRequest(*securityhub.ListFindingAggregatorsInput) (*request.Request, *securityhub.ListFindingAggregatorsOutput) + + ListFindingAggregatorsPages(*securityhub.ListFindingAggregatorsInput, func(*securityhub.ListFindingAggregatorsOutput, bool) bool) error + ListFindingAggregatorsPagesWithContext(aws.Context, *securityhub.ListFindingAggregatorsInput, func(*securityhub.ListFindingAggregatorsOutput, bool) bool, ...request.Option) error + ListInvitations(*securityhub.ListInvitationsInput) (*securityhub.ListInvitationsOutput, error) ListInvitationsWithContext(aws.Context, *securityhub.ListInvitationsInput, ...request.Option) (*securityhub.ListInvitationsOutput, error) ListInvitationsRequest(*securityhub.ListInvitationsInput) (*request.Request, *securityhub.ListInvitationsOutput) @@ -277,6 +296,10 @@ type SecurityHubAPI interface { UpdateActionTargetWithContext(aws.Context, *securityhub.UpdateActionTargetInput, ...request.Option) (*securityhub.UpdateActionTargetOutput, error) UpdateActionTargetRequest(*securityhub.UpdateActionTargetInput) (*request.Request, *securityhub.UpdateActionTargetOutput) + UpdateFindingAggregator(*securityhub.UpdateFindingAggregatorInput) (*securityhub.UpdateFindingAggregatorOutput, error) + UpdateFindingAggregatorWithContext(aws.Context, *securityhub.UpdateFindingAggregatorInput, ...request.Option) (*securityhub.UpdateFindingAggregatorOutput, error) + UpdateFindingAggregatorRequest(*securityhub.UpdateFindingAggregatorInput) (*request.Request, *securityhub.UpdateFindingAggregatorOutput) + UpdateFindings(*securityhub.UpdateFindingsInput) (*securityhub.UpdateFindingsOutput, error) UpdateFindingsWithContext(aws.Context, *securityhub.UpdateFindingsInput, ...request.Option) (*securityhub.UpdateFindingsOutput, error) UpdateFindingsRequest(*securityhub.UpdateFindingsInput) (*request.Request, *securityhub.UpdateFindingsOutput) diff --git a/service/transcribestreamingservice/api.go b/service/transcribestreamingservice/api.go index 2ba4dde435..a02b59c2f8 100644 --- a/service/transcribestreamingservice/api.go +++ b/service/transcribestreamingservice/api.go @@ -2645,6 +2645,9 @@ type StartStreamTranscriptionInput struct { // LanguageCode is a required field LanguageCode *string `location:"header" locationName:"x-amzn-transcribe-language-code" type:"string" required:"true" enum:"LanguageCode"` + // The name of the language model you want to use. + LanguageModelName *string `location:"header" locationName:"x-amzn-transcribe-language-model-name" min:"1" type:"string"` + // The encoding used for the input audio. // // MediaEncoding is a required field @@ -2669,10 +2672,6 @@ type StartStreamTranscriptionInput struct { // entity types, you must have either ContentIdentificationType or ContentRedactionType // enabled. // - // PIIEntityTypes must be comma-separated; the available values are: BANK_ACCOUNT_NUMBER, - // BANK_ROUTING, CREDIT_DEBIT_NUMBER, CREDIT_DEBIT_CVV, CREDIT_DEBIT_EXPIRY, - // PIN, EMAIL, ADDRESS, NAME, PHONE, SSN, and ALL. - // // PiiEntityTypes is an optional parameter with a default value of ALL. PiiEntityTypes *string `location:"header" locationName:"x-amzn-transcribe-pii-entity-types" min:"1" type:"string"` @@ -2723,6 +2722,9 @@ func (s *StartStreamTranscriptionInput) Validate() error { if s.LanguageCode == nil { invalidParams.Add(request.NewErrParamRequired("LanguageCode")) } + if s.LanguageModelName != nil && len(*s.LanguageModelName) < 1 { + invalidParams.Add(request.NewErrParamMinLen("LanguageModelName", 1)) + } if s.MediaEncoding == nil { invalidParams.Add(request.NewErrParamRequired("MediaEncoding")) } @@ -2784,6 +2786,12 @@ func (s *StartStreamTranscriptionInput) SetLanguageCode(v string) *StartStreamTr return s } +// SetLanguageModelName sets the LanguageModelName field's value. +func (s *StartStreamTranscriptionInput) SetLanguageModelName(v string) *StartStreamTranscriptionInput { + s.LanguageModelName = &v + return s +} + // SetMediaEncoding sets the MediaEncoding field's value. func (s *StartStreamTranscriptionInput) SetMediaEncoding(v string) *StartStreamTranscriptionInput { s.MediaEncoding = &v @@ -2864,6 +2872,8 @@ type StartStreamTranscriptionOutput struct { // The language code for the input audio stream. LanguageCode *string `location:"header" locationName:"x-amzn-transcribe-language-code" type:"string" enum:"LanguageCode"` + LanguageModelName *string `location:"header" locationName:"x-amzn-transcribe-language-model-name" min:"1" type:"string"` + // The encoding used for the input audio stream. MediaEncoding *string `location:"header" locationName:"x-amzn-transcribe-media-encoding" type:"string" enum:"MediaEncoding"` @@ -2948,6 +2958,12 @@ func (s *StartStreamTranscriptionOutput) SetLanguageCode(v string) *StartStreamT return s } +// SetLanguageModelName sets the LanguageModelName field's value. +func (s *StartStreamTranscriptionOutput) SetLanguageModelName(v string) *StartStreamTranscriptionOutput { + s.LanguageModelName = &v + return s +} + // SetMediaEncoding sets the MediaEncoding field's value. func (s *StartStreamTranscriptionOutput) SetMediaEncoding(v string) *StartStreamTranscriptionOutput { s.MediaEncoding = &v